Retrieve Campaign Details

Use this endpoint to retrieve details on a particular campaign in Engage

Endpoint and Methods

GET /_rest/v2/campaigns?id=xxxxxx

Parameters

Note: Either the "Id" or "Name" parameter is required.

  • Id:

    • Key = id; Value = campaignId

  • Name:

    • Key = name; Value = campaignName

Sample Request

Example with Id:

GET/_rest/v2/campaigns/?id=5c19078a717a743602510e23

Example with Name:

GET/_rest/v2/campaigns/?name=testing

Note: Your query must include at least four characters and spaces are allowed.

Sample Responses

Code 200 Response

Response code 200 returns a campaign object.

Copy

{
"listRel": [
 "5c1a4728717a743602510e48"
 ],
 "location": "US",
 "_id": "5cf02630e313d620ca9743e4",
 "campaignName": "testing ethel",
 "campaignDescription": "",
 "callerIdentification": "+13122735567",
 "startDate": "2019-06-26T00:00:00.000Z",
 "endDate": "2019-06-29T00:00:00.000Z",
 "active": 1,
 "numAttempts": 1,
 "appId": "5cf02606b4623d6a23167b23",
 "runNow": false,
 "modifiedDate": "2019-06-26T19:58:00.871Z",
 "modifiedBy": "ethel",
 "customerId": "9999999",
 "createdDate": "2019-05-30T18:51:28.963Z",
 "createdBy": "ethel",
 "deleteFlag": flase,
 "lastExecuted": "",
 "scheduled": "5d13bfcd4c36cca2d46a0a8d",
 "retryInterval": 0,
 "flowId": "5bef29e1c5480c40e2ab4ef0",
 "timezone": "(CET) - mainterritory of Spain"
},

Code 401 Response

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

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

Code 404 Response

Response code 404 returns a message that the campaign id or name is wrong and the campaign is not found.

 

Code 500 Response

Response code 500 returns an error when trying to retrieve campaign details.

Copy
{
"message": "Something went wrong when trying to get campaign details",
"status": 500
}