Associate a List

Use this endpoint to link a list to a campaign in Engage.

Endpoint and Methods

POST /_rest/v2/campaigns/:id/action

Parameters

  • Campaign Id

Body

Required fields:

  • action

  • selectedLists array (valid list ids)

Sample Request

Copy
{
“action”: “associate”,
“selectedLists”: “51i8c0edotame81bb4cbf000”
}

Sample Responses

Code 200 Response

Response code 200 returns a boolean value of true indicating that the list was associated to your campaign.

Copy

true

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.

 

Code 422 Response

Response code 422 returns a message that the list id (selectedLists array) or action is missing, empty or invalid.

 

Code 500 Response

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

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