Retry failed campaign recipients

Resets non-permanent failed recipients to pending and re-enqueues dispatch. Permanent Meta codes (opt-out, experiment, undeliverable, template hard fails) are left failed.

POST/v1/campaigns/{campaignID}/retry-failed

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

campaignIDstringrequired

Responses

200OK

campaignCampaignItemrequired

Show properties

audience_source_idstring

audience_source_typestringrequired

canceled_atstring

completed_atstring

created_atstringrequired

descriptionstring

explicit_contact_idsstring[] | null

failed_atstring

idstringrequired

metadataany

namestringrequired

organization_idstringrequired

scheduled_atstring

started_atstring

statusstringrequired

updated_atstringrequired

reset_countinteger<int64>required

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/campaigns/string/retry-failed"

const response = await fetch("/v1/campaigns/string/retry-failed", {
  method: "POST"
});

import requests

response = requests.post(
    "/v1/campaigns/string/retry-failed",
)

Response

{
  "campaign": {
    "audience_source_id": "string",
    "audience_source_type": "string",
    "canceled_at": "string",
    "completed_at": "string",
    "created_at": "string",
    "description": "string",
    "explicit_contact_ids": [
      "string"
    ],
    "failed_at": "string",
    "id": "string",
    "metadata": "string",
    "name": "string",
    "organization_id": "string",
    "scheduled_at": "string",
    "started_at": "string",
    "status": "string",
    "updated_at": "string"
  },
  "reset_count": 0
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}