Update a Campaign

Use this endpoint to revise an existing campaign in Engage.

Endpoint and Methods

PUT /_rest/v2/campaigns/:id

Parameters

  • Campaign Id

Body

Required fields:

  • campaignName

  • flowId

  • callerIdentification

Optional field:

  • campaignDescription

    Note: These fields can be updated in the body.

Sample Request

Copy
{
  "callerIdentification": "+16075175200",
  "campaignName": "Florida SMS Test",  
  "flowId": "5bef29e1c5480c40e2ab4ef0",
  "campaignDescription": "This is a Florida SMS Test"
}

Sample Responses

Code 200 Response

Response code 200 returns a campaign object.

Copy
{
"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"
}

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 parameter is incorrect.

Copy
{
"message": "The 'campaign id' parameter is required",
"status": 404
}

Code 500 Response

Response code 500 returns an error when trying to update the campaign.

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