Sign in
latestOpenAPI 3.0.32026-08-10362374.4 KB

98c494325aae

Campaign

Search Campaigns

Returns the organizations Campaigns in paginated format. The pagination is handled with the startIndex and length keys in the request body. There are two filtering options within the body:

  • searchTerm field is searched within the titles of the Campaigns
  • status field takes in the status enum values in an array to filter the results
post/campaign/search

Headers

api-versionstring required

The API version. Current version is 3.3. This value has to be set in every request.

Request body

startIndexinteger
lengthinteger
statusinteger[]

Campaign status enum values (0=NoEntry, 1=Draft, 2=Scheduled, 3=Sent)

searchTermstring

Response

Successful response

messagestring nullable
hasErrorboolean
validationErrorsstring[]
{"stackTrail":"components:schemas:ApiResponse:properties:data","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:ApiResponse:properties:content","oasType":"schema","type":"unknown","nullable":true}