Create campaign

POST/v1/campaigns

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

audience_source_idstring

audience_source_typestring

descriptionstring

explicit_contact_idsstring[] | null

metadataany

namestringrequired

scheduled_atstring

Responses

201Created

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

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" \
  -H "Content-Type: application/json" \
  -d '{
  "audience_source_id": "string",
  "audience_source_type": "string",
  "description": "string",
  "explicit_contact_ids": [
    "string"
  ],
  "metadata": "string",
  "name": "string",
  "scheduled_at": "string"
}'

const response = await fetch("/v1/campaigns", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "audience_source_id": "string",
  "audience_source_type": "string",
  "description": "string",
  "explicit_contact_ids": [
    "string"
  ],
  "metadata": "string",
  "name": "string",
  "scheduled_at": "string"
})
});

import requests

response = requests.post(
    "/v1/campaigns",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "audience_source_id": "string",
  "audience_source_type": "string",
  "description": "string",
  "explicit_contact_ids": [
    "string"
  ],
  "metadata": "string",
  "name": "string",
  "scheduled_at": "string"
},
)

Response

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

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