Get campaigns

get

https://api.indigitall.com/v2/chat/{applicationId}/campaign

List all the campaigns and their details for a given application

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

applicationId

integer

required

Application's ID

Query Params

limit

integer

1 to 100

Defaults to 25

Limit the number of campaigns returned

page

integer

≥ 0

Defaults to 0

Page number

orderBy

string

^(title|createdAt|updatedAt)-(asc|desc)$

Defaults to createdAt-desc

Sorts the results by field and direction:

title-asc Order by title ascending. From A to Z.
title-desc Order by title descending. From Z to A.
createdAt-asc Order by creation date ascending.
createdAt-desc Order by creation date descending.
updatedAt-asc Order by last update date ascending.
updatedAt-desc Order by last update date descending.

enabled

boolean

Filter the campaigns by the enabled status:

true Return only enabled campaigns.
false Return only disabled campaigns.

If not provided, both enabled and disabled campaigns will be returned.

title

string

Filter the campaigns by title.
Performs a flexible search (case-insensitive and accent-insensitive).

count

boolean

Defaults to false

Returns the number of campaigns that match the specified filter criteria.
If set to true, the response will include the count property.
If set to false, the response will only include the data property.

lastSendingMode

string

enum

Filter by the mode of the last sending.

Allowed:

contentTypes

array of strings

Filter the campaigns by message content type.
Returns campaigns that contain at least one message of any of the given types (e.g. template).

contentTypes

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Retrieve information about all campaigns for a given application

403Forbidden

404Not found

500Internal server error