Pause

POST

https://api//api/public/campaign/Pause?campaignId=<long>

POST

//api/public/campaign/Pause?campaignId=<long>

curl -X POST "https://api/api/public/campaign/Pause?campaignId=<long>?campaignId=%3Clong%3E" \
     -H "X-API-KEY: <string>"

{
  "totalCount": "<integer>",
  "items": [
    {
      "id": "<long>",
      "name": "<string>",
      "creationTime": "<dateTime>",
      "linkedInUserListName": "<string>",
      "linkedInUserListId": "<long>",
      "campaignAccountIds": [
        "<integer>",
        "<integer>"
      ],
      "progressStats": {
        "totalUsers": "<integer>",
        "totalUsersInProgress": "<integer>",
        "totalUsersPending": "<integer>",
        "totalUsersFinished": "<integer>",
        "totalUsersFailed": "<integer>"
      },
      "excludeAlreadyMessagedGlobal": "<boolean>",
      "excludeAlreadyMessagedCampaignAccounts": "<boolean>",
      "excludeFirstConnectionCampaignAccounts": "<boolean>",
      "excludeFirstConnectionGlobal": "<boolean>",
      "excludeNoProfilePicture": "<boolean>",
      "excludeListId": "<long>"
    },
    {
      "id": "<long>",
      "name": "<string>",
      "creationTime": "<dateTime>",
      "linkedInUserListName": "<string>",
      "linkedInUserListId": "<long>",
      "campaignAccountIds": [
        "<integer>",
        "<integer>"
      ],
      "progressStats": {
        "totalUsers": "<integer>",
        "totalUsersInProgress": "<integer>",
        "totalUsersPending": "<integer>",
        "totalUsersFinished": "<integer>",
        "totalUsersFailed": "<integer>"
      },
      "excludeAlreadyMessagedGlobal": "<boolean>",
      "excludeAlreadyMessagedCampaignAccounts": "<boolean>",
      "excludeFirstConnectionCampaignAccounts": "<boolean>",
      "excludeFirstConnectionGlobal": "<boolean>",
      "excludeNoProfilePicture": "<boolean>",
      "excludeListId": "<long>"
    }
  ]
}

Pauses the specified campaign.

Query parameters

campaignIdstringOptional

Response

totalCountstring

itemslist of objects

Errors

400

Pause Campaigns Request Bad Request Error

401

Pause Campaigns Request Unauthorized Error

404

Pause Campaigns Request Not Found Error

429

Pause Campaigns Request Too Many Requests Error

Headers

Query parameters

Response

Errors