Terminally close every queued and parked retry in the workspace

POST /campaigns/retry-queue/cancel

Terminally close every queued and parked retry in the workspace

cURL

curl --request POST \
  --url https://api.pineyard.ai/campaigns/retry-queue/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaignIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "reasons": [],
  "attemptCountMin": 1,
  "attemptCountMax": 1
}
'

200

{
  "affected": 123,
  "complete": true
}

Required scope: campaigns.delete

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Body

application/json

campaignIds · string<uuid>[]

Required array length: 1 - 200 elements

reasons · enum<string>[]

Minimum array length: 1

Available options: RETRY_NO_ANSWER, RETRY_DROPPED, PROVIDER_ERROR, RECONCILED_STRANDED, NEXT_NUMBER, UNKNOWN

attemptCountMin · integer

Required range: x >= 0

attemptCountMax · integer

Required range: x >= 0

Response

200

application/json

OK

affected · number · required

complete · boolean · required