Campaign Management

List

Use campaigns to list all of your campaigns in Engage.

 

Endpoint and methods
  • GET: /api​/v2​/campaigns
 
Parameters

Headers

  • Accept: application/json
  • Authorization: xxxxxxxxxxxxxxxxx
  • Content-Type: application/json

 

Field

Type

Description

Accept

String

application/json

 

Authorization

 

String

Authorization token (see Authenticate)

Content-Type

String

 

application/json

Error Name

Type

Description

code

Integer

Error code

 

error

String

Error description

Response code 200 returns a list of campaign objects.

 

[
{
"campaignName": "Texas SMS Test",
"campaignId": "5c1097c6717a743602510c9c",
"campaignDescription": "This is a Texas SMS test",
"callerIdentification": "+13122735567",
"flowTypeId": "5d24c0e64886e81bb4cbf069",
"startDate": "2019-06-18",
"endDate": "2019-06-18",
"active": 1,
"numAttempts": "5",
"retryInterval": "10",
"appId": "",
"runNow": "true",
"scheduleId": "5f24c065jkl0p81bb4cbf069",
"modifiedDate": "2019-06-18T00:14:03Z",
"modifiedBy": "sspeirs",
"createdDate": "2019-06-18T00:14:03Z",
"createdBy": "sspeirs",
"deleteFlag": "false",
"customerId": 9999999,
"listRel": [
"4kk11065jkl0985bb48mf054"
],
"utcName": "United States Minor Outlying Islands - Baker Island",
"utcOffset": "−12:00"
}
]

 

Response code 401 returns an error that the authorization token is invalid.

 

{
"message": "string",
"status": 401
}

Response code 500 returns an error when trying to retrieve a list of your campaigns.

 

{
"message": "Something went wrong during the listing of a customer's campaigns",
"status": 500
}