---
title: "Start a campaign"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.getarbol.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Start a campaign

Path: Raíz API › Campaigns

`POST /v1/raiz/campaigns/{campaignId}/start`

Start reaching people: from now on the campaign's due recipients are called, at most `settings.channels.maxConcurrentOutboundCalls` (five by default) at once across the organization, or sent their message, a few a second. A call campaign needs an active, published voice Agent (VOICE_AGENT_NOT_READY). A WhatsApp campaign needs an active text Agent (CAMPAIGN_AGENT_NOT_READY), a line that can send (CHANNEL_NOT_READY), an approved template whose parameters fit (a `TEMPLATE_*` code), a value for every variable (CAMPAIGN_VARIABLE_MISSING) and, when the template's header is a document, image or video, the first pending recipient's own `header` file (CAMPAIGN_HEADER_MISSING). A recipient must be pending (CAMPAIGN_NO_RECIPIENTS). What reaching each pending recipient once would cost is checked against the organization's balance: when the balance does not cover it and billing stops the organization's work for that, it does not start (CREDITS_EXHAUSTED). `get_campaign` with `expand=readiness` lists all of this beforehand, with the estimate. A campaign starts once: starting a running one changes nothing, and a paused one resumes with `update_campaign` and `paused: false`. Not an AI tool: it reaches real people.

- **Scope:** `raiz:campaigns:write`
- **Credentials:** an API key, a client-credentials token or a person's access token
- **Effect:** writes
- **Limits:** request body up to 32 KB, response up to 1 MB
- **CLI:** `arbol raiz campaigns start` · not available on MCP

## Authentication

Requires one of the following:

- `arbolHuman`, oauth2, scopes: `raiz:campaigns:write`
- `arbolMachine`, oauth2, scopes: `raiz:campaigns:write`
- `arbolApiKey`, http, header `Authorization`

## Path parameters

- `campaignId` (`raiz.campaigns.start.path.campaignId`; string, required) — Campaign id.
  - pattern `^cmp_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$`

## Request body

_Required._

## Example request

```json
{}
```

## Code samples

### cURL

```bash
curl https://api.getarbol.com/v1/raiz/campaigns/cmp_01m45h8q2rf3t9w6y7z0b1c2d3/start \
  --request POST \
  --header "Authorization: Bearer $ARBOL_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{}'
```

### TypeScript

```typescript
import { createClient } from "@arbol-ai/sdk";

const arbol = createClient({
  baseUrl: "https://api.getarbol.com",
  token: process.env.ARBOL_API_KEY!,
});

const { data } = await arbol.raiz.campaigns.start({
  campaignId: "cmp_01m45h8q2rf3t9w6y7z0b1c2d3",
  body: {},
});
```

### Rust

```rust
use arbol_sdk::{types, Client, Credential};

let arbol = Client::new(Credential::ApiKey(std::env::var("ARBOL_API_KEY")?))?;

let data = arbol
    .raiz()
    .campaigns()
    .start(&types::RaizCampaignsStartInput {
        campaign_id: "cmp_01m45h8q2rf3t9w6y7z0b1c2d3".into(),
    })
    .await?;
```

### CLI

```bash
arbol raiz campaigns start cmp_01m45h8q2rf3t9w6y7z0b1c2d3
```

## Responses

### 200

Successful operation.

#### Example

```json
{
  "success": true,
  "data": {
    "agentId": "agt_01m45h8q2rf3t9w6y7z0b1c2d3",
    "channelId": "chn_01m45h8q2rf3t9w6y7z0b1c2d3",
    "channelType": "voice",
    "contactHours": [
      {
        "days": [
          "MO"
        ],
        "from": "09:00",
        "to": "18:00"
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "endedAt": "2019-08-24T14:15:22Z",
    "errorAt": "2019-08-24T14:15:22Z",
    "errorCode": "string",
    "firstMessage": "string",
    "id": "cmp_01m45h8q2rf3t9w6y7z0b1c2d3",
    "instructions": "string",
    "maxAttempts": 1,
    "metadata": {},
    "name": "string",
    "progress": {
      "answered": 0,
      "buttons": [
        {
          "recipients": 0,
          "text": "string"
        }
      ],
      "completed": 0,
      "delivered": 0,
      "failed": 0,
      "inProgress": 0,
      "noAnswer": 0,
      "noButton": 0,
      "noReply": 0,
      "pending": 0,
      "read": 0,
      "recipients": 0,
      "replied": 0,
      "succeeded": 0
    },
    "retryAfterMinutes": 1,
    "retryOn": [
      "no_answer"
    ],
    "scheduledEndAt": "2019-08-24T14:15:22Z",
    "scheduledStartAt": "2019-08-24T14:15:22Z",
    "startedAt": "2019-08-24T14:15:22Z",
    "status": "queued",
    "template": {
      "language": "string",
      "name": "string",
      "parameters": [
        "string"
      ]
    },
    "timeZone": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "version": 1,
    "waitingUntilAt": "2019-08-24T14:15:22Z",
    "readiness": {
      "blockers": [
        {
          "address": "string",
          "code": "string",
          "variable": "string"
        }
      ],
      "estimate": {
        "callMinutes": {
          "calls": 0,
          "perCall": 0
        },
        "covered": true,
        "credits": 0,
        "degraded": true,
        "enforced": true,
        "people": 0
      },
      "preview": "string",
      "ready": true
    },
    "recipients": {
      "data": [
        {
          "address": "string",
          "attemptCount": 0,
          "button": {
            "pressedAt": "2019-08-24T14:15:22Z",
            "text": "string"
          },
          "contact": {
            "id": "cnt_01m45h8q2rf3t9w6y7z0b1c2d3",
            "name": "string"
          },
          "contactId": "cnt_01m45h8q2rf3t9w6y7z0b1c2d3",
          "createdAt": "2019-08-24T14:15:22Z",
          "deliveredAt": "2019-08-24T14:15:22Z",
          "errorCode": "string",
          "familyName": "string",
          "firstMessage": "string",
          "givenName": "string",
          "id": "rcp_01m45h8q2rf3t9w6y7z0b1c2d3",
          "instructions": "string",
          "lastAttempt": {
            "conversationId": "cnv_01m45h8q2rf3t9w6y7z0b1c2d3",
            "outcome": "success",
            "startedAt": "2019-08-24T14:15:22Z",
            "status": "open"
          },
          "nextAttemptAt": "2019-08-24T14:15:22Z",
          "readAt": "2019-08-24T14:15:22Z",
          "repliedAt": "2019-08-24T14:15:22Z",
          "results": [
            {
              "definitionKey": "string",
              "label": "string",
              "value": "string"
            }
          ],
          "status": "pending",
          "updatedAt": "2019-08-24T14:15:22Z",
          "variables": {}
        }
      ],
      "object": "list",
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "nextCursor": "string",
        "previousCursor": "string"
      }
    },
    "results": [
      {
        "definition": {
          "key": "string",
          "name": "string"
        },
        "values": [
          {
            "key": "string",
            "label": "string",
            "people": 1
          }
        ]
      }
    ]
  },
  "error": null,
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.200.success`; boolean, required)
  - one of `true`
- `data` (`raiz.campaigns.start.response.200.data`; object, required)
  - `agentId` (`raiz.campaigns.start.response.200.data.agentId`; string, required) — Agent id.
    - pattern `^agt_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$`
  - `channelId` (`raiz.campaigns.start.response.200.data.channelId`; string | null, required) — The line calls or messages leave from. Null: the Agent's own.
    - pattern `^(?:chn_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))|(?:agc)_(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$`
  - `channelType` (`raiz.campaigns.start.response.200.data.channelType`; string, required) — How the campaign reaches people: by call or by WhatsApp.
    - one of `"voice"`, `"whatsapp"`
  - `contactHours` (`raiz.campaigns.start.response.200.data.contactHours`; array<object>, required) — When calls may start and messages may leave, in the campaign's time zone. Empty: any time. Public holidays count like any other day: whether to reach people on one is the organization's decision.
    - `days` (`raiz.campaigns.start.response.200.data.contactHours.days`; array<string>, required)
      - one of `"MO"`, `"TU"`, `"WE"`, `"TH"`, `"FR"`, `"SA"`, `"SU"`
    - `from` (`raiz.campaigns.start.response.200.data.contactHours.from`; string, required) — Local start time, `HH:MM`, inclusive.
      - pattern `^([01][0-9]|2[0-3]):[0-5][0-9]$`
    - `to` (`raiz.campaigns.start.response.200.data.contactHours.to`; string, required) — Local end time, `HH:MM`, exclusive (`24:00` for midnight).
      - pattern `^(([01][0-9]|2[0-3]):[0-5][0-9]|24:00)$`
  - `createdAt` (`raiz.campaigns.start.response.200.data.createdAt`; string, required) — An instant in RFC 3339 format, in UTC.
    - format `date-time`
  - `endedAt` (`raiz.campaigns.start.response.200.data.endedAt`; string | null, required) — An instant in RFC 3339 format, in UTC.
    - format `date-time`
  - `errorAt` (`raiz.campaigns.start.response.200.data.errorAt`; string | null, required) — When `errorCode` was first seen.
    - format `date-time`
  - `errorCode` (`raiz.campaigns.start.response.200.data.errorCode`; string | null, required) — Why the campaign cannot reach anyone now, such as `TEMPLATE_NOT_APPROVED` or `WHATSAPP_RATE_LIMITED`. Null when nothing is wrong. Cleared when a call or message gets through or the campaign changes; nobody loses an attempt to it.
  - `firstMessage` (`raiz.campaigns.start.response.200.data.firstMessage`; string | null, required)
  - `id` (`raiz.campaigns.start.response.200.data.id`; string, required) — Campaign id.
    - pattern `^cmp_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$`
  - `instructions` (`raiz.campaigns.start.response.200.data.instructions`; string | null, required)
  - `maxAttempts` (`raiz.campaigns.start.response.200.data.maxAttempts`; integer, required)
    - min 1; max 10
  - `metadata` (`raiz.campaigns.start.response.200.data.metadata`; object, required) — Your own keys and labels for this resource (up to 50 keys of 40 characters; values up to 500 characters). Raíz never interprets them.
  - `name` (`raiz.campaigns.start.response.200.data.name`; string, required)
  - `progress` (`raiz.campaigns.start.response.200.data.progress`; object, required) — How many recipients are in each state.
    - `answered` (`raiz.campaigns.start.response.200.data.progress.answered`; integer, required) — Calls: recipients whose latest call someone answered and its analysis judged.
      - min 0
    - `buttons` (`raiz.campaigns.start.response.200.data.progress.buttons`; array<object>, required) — WhatsApp: the template's quick-reply buttons people pressed, most pressed first, each with how many recipients pressed it last. A recipient counts once, under their latest press. A button nobody pressed is not listed. Read from the reply itself: a written answer is not a button.
      - `recipients` (`raiz.campaigns.start.response.200.data.progress.buttons.recipients`; integer, required) — How many recipients have it as their last press.
        - min 0
      - `text` (`raiz.campaigns.start.response.200.data.progress.buttons.text`; string, required) — The button's text, as the template shows it.
        - minLength 1; maxLength 256
    - `completed` (`raiz.campaigns.start.response.200.data.progress.completed`; integer, required)
      - min 0
    - `delivered` (`raiz.campaigns.start.response.200.data.progress.delivered`; integer, required) — WhatsApp: recipients who received a message.
      - min 0
    - `failed` (`raiz.campaigns.start.response.200.data.progress.failed`; integer, required)
      - min 0
    - `inProgress` (`raiz.campaigns.start.response.200.data.progress.inProgress`; integer, required)
      - min 0
    - `noAnswer` (`raiz.campaigns.start.response.200.data.progress.noAnswer`; integer, required) — Calls: recipients who failed because their calls ran out without anyone answering. A voicemail counts here.
      - min 0
    - `noButton` (`raiz.campaigns.start.response.200.data.progress.noButton`; integer, required) — WhatsApp: recipients a message reached (`deliveredAt`) who pressed none of its buttons, whether or not they wrote. People still pending, or whose message never arrived, are not counted.
      - min 0
    - `noReply` (`raiz.campaigns.start.response.200.data.progress.noReply`; integer, required) — WhatsApp: recipients a message reached who neither pressed a button nor wrote: `noButton` less those who answered in writing.
      - min 0
    - `pending` (`raiz.campaigns.start.response.200.data.progress.pending`; integer, required)
      - min 0
    - `read` (`raiz.campaigns.start.response.200.data.progress.read`; integer, required) — WhatsApp: recipients who read a message.
      - min 0
    - `recipients` (`raiz.campaigns.start.response.200.data.progress.recipients`; integer, required)
      - min 0
    - `replied` (`raiz.campaigns.start.response.200.data.progress.replied`; integer, required) — WhatsApp: recipients who replied.
      - min 0
    - `succeeded` (`raiz.campaigns.start.response.200.data.progress.succeeded`; integer, required) — Recipients whose latest conversation's analysis judged it successful.
      - min 0
  - `retryAfterMinutes` (`raiz.campaigns.start.response.200.data.retryAfterMinutes`; integer, required)
    - min 1
  - `retryOn` (`raiz.campaigns.start.response.200.data.retryOn`; array<string>, required)
    - one of `"no_answer"`, `"failure"`, `"not_delivered"`
  - `scheduledEndAt` (`raiz.campaigns.start.response.200.data.scheduledEndAt`; string | null, required) — An instant in RFC 3339 format, in UTC.
    - format `date-time`
  - `scheduledStartAt` (`raiz.campaigns.start.response.200.data.scheduledStartAt`; string | null, required) — An instant in RFC 3339 format, in UTC.
    - format `date-time`
  - `startedAt` (`raiz.campaigns.start.response.200.data.startedAt`; string | null, required) — An instant in RFC 3339 format, in UTC.
    - format `date-time`
  - `status` (`raiz.campaigns.start.response.200.data.status`; string, required) — `queued`: not started yet (or its start is scheduled). `running`: reaching due recipients. `paused`: started, then paused; what is in progress finishes. `completed`: no recipient is left to reach.
    - one of `"queued"`, `"running"`, `"paused"`, `"completed"`, `"cancelled"`, `"failed"`
  - `template` (`raiz.campaigns.start.response.200.data.template`; any of, required)
    - any of: `RaizCampaignTemplate`, `null`
  - `timeZone` (`raiz.campaigns.start.response.200.data.timeZone`; string, required)
  - `updatedAt` (`raiz.campaigns.start.response.200.data.updatedAt`; string, required) — An instant in RFC 3339 format, in UTC.
    - format `date-time`
  - `version` (`raiz.campaigns.start.response.200.data.version`; integer, required)
    - min 1
  - `waitingUntilAt` (`raiz.campaigns.start.response.200.data.waitingUntilAt`; string | null, required) — When it tries again after `errorCode`, later each time the same problem lasts: from fifteen minutes up to six hours.
    - format `date-time`
  - `readiness` (`raiz.campaigns.start.response.200.data.readiness`; object, optional) — Whether the campaign can start, checked against its Agent, line, template, recipients and the organization's balance without reaching anyone. Present only when expanded.
    - `blockers` (`raiz.campaigns.start.response.200.data.readiness.blockers`; array<object>, required) — What has to be fixed first. Empty when it can start.
      - `code` (`raiz.campaigns.start.response.200.data.readiness.blockers.code`; string, required) — The error `startCampaign` would refuse with: `CAMPAIGN_AGENT_NOT_READY`, `CAMPAIGN_NO_RECIPIENTS`, `CAMPAIGN_VARIABLE_MISSING`, `CHANNEL_NOT_READY`, `CREDITS_EXHAUSTED` (see `estimate`), a `TEMPLATE_*` code, `UPSTREAM_UNAVAILABLE` or `VOICE_AGENT_NOT_READY`.
      - `address` (`raiz.campaigns.start.response.200.data.readiness.blockers.address`; string, optional) — The recipient it is about, when it is one.
      - `variable` (`raiz.campaigns.start.response.200.data.readiness.blockers.variable`; string, optional) — The variable it lacks, when it is one.
    - `estimate` (`raiz.campaigns.start.response.200.data.readiness.estimate`; object, required) — What reaching each pending recipient once would cost, checked against the organization's balance without reaching anyone.
      - `callMinutes` (`raiz.campaigns.start.response.200.data.readiness.estimate.callMinutes`; object | null, required) — Calls: what each call is counted at, from the organization's own recent outbound calls; an estimate, since a call's length is known only once it happens. Null on WhatsApp, and when the organization has made too few such calls to tell: the calls' minutes are then not counted and `credits` is null.
        - `calls` (`raiz.campaigns.start.response.200.data.readiness.estimate.callMinutes.calls`; integer, required) — How many of those calls the figure comes from.
          - min 0
        - `perCall` (`raiz.campaigns.start.response.200.data.readiness.estimate.callMinutes.perCall`; number, required) — Minutes billed per call on average, a call nobody answered counting zero.
          - min 0
      - `covered` (`raiz.campaigns.start.response.200.data.readiness.estimate.covered`; boolean, required) — Whether the organization's balance covers `credits`, or the organization is never stopped at zero, as billing answers it now. True when nothing was counted, or billing did not answer (`degraded`).
      - `credits` (`raiz.campaigns.start.response.200.data.readiness.estimate.credits`; number | null, required) — What reaching each of `people` once would cost at the organization's rates, in credits (one credit is one US dollar), valued as billing values what is used. On WhatsApp it counts each opening message, its template and the conversation it opens; on calls, each call's minutes at `callMinutes.perCall`. Never counted: the attempts after the first, the replies, the Agent's answers, what its tools use and a line's own charge when the plan bills it apart. What the plan includes is not discounted, so the real cost can be lower. Null when nothing could be counted or billing did not value it.
        - min 0
      - `degraded` (`raiz.campaigns.start.response.200.data.readiness.estimate.degraded`; boolean, required) — Billing did not answer in time: `credits` may be null, and `covered` is assumed.
      - `enforced` (`raiz.campaigns.start.response.200.data.readiness.estimate.enforced`; boolean, required) — Whether a balance that does not cover what is used stops this organization's work now. When it does and `covered` is false, the campaign cannot start (`CREDITS_EXHAUSTED`); while it does not, it starts anyway. False when nothing was counted.
      - `people` (`raiz.campaigns.start.response.200.data.readiness.estimate.people`; integer, required) — The recipients still to be reached, each counted once.
        - min 0
    - `preview` (`raiz.campaigns.start.response.200.data.readiness.preview`; string | null, required) — WhatsApp: the message as the first pending recipient would read it. Null when it cannot be told yet.
    - `ready` (`raiz.campaigns.start.response.200.data.readiness.ready`; boolean, required) — Whether `startCampaign` would accept it now.
  - `recipients` (`raiz.campaigns.start.response.200.data.recipients`; object, optional) — The campaign's recipients in the order they were added, each with its latest attempt. Present only when expanded.
    - `data` (`raiz.campaigns.start.response.200.data.recipients.data`; array<object>, required) — Items admitted by this resource contract within the verified organization.
      - `address` (`raiz.campaigns.start.response.200.data.recipients.data.address`; string, required)
      - `attemptCount` (`raiz.campaigns.start.response.200.data.recipients.data.attemptCount`; integer, required)
        - min 0
      - `button` (`raiz.campaigns.start.response.200.data.recipients.data.button`; object | null, required) — WhatsApp: the last button of the template this person pressed, and when. A later press replaces an earlier one, also after their conversation closed. Null when they pressed none: a written answer is not a button.
        - `pressedAt` (`raiz.campaigns.start.response.200.data.recipients.data.button.pressedAt`; string, required) — An instant in RFC 3339 format, in UTC.
          - format `date-time`
        - `text` (`raiz.campaigns.start.response.200.data.recipients.data.button.text`; string, required) — The button's text, as the template shows it.
          - minLength 1; maxLength 256
      - `contact` (`raiz.campaigns.start.response.200.data.recipients.data.contact`; object | null, required) — The contact this person is: the one the list named, else the one that owns the number. Null when the organization has none yet; the campaign creates it when it reaches them.
        - `id` (`raiz.campaigns.start.response.200.data.recipients.data.contact.id`; string, required) — Contact id.
          - pattern `^cnt_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$`
        - `name` (`raiz.campaigns.start.response.200.data.recipients.data.contact.name`; string | null, required) — Their saved name, else the name they show on WhatsApp; null when the organization has neither.
      - `contactId` (`raiz.campaigns.start.response.200.data.recipients.data.contactId`; string | null, required) — Contact id.
        - pattern `^cnt_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$`
      - `createdAt` (`raiz.campaigns.start.response.200.data.recipients.data.createdAt`; string, required) — An instant in RFC 3339 format, in UTC.
        - format `date-time`
      - `deliveredAt` (`raiz.campaigns.start.response.200.data.recipients.data.deliveredAt`; string | null, required) — WhatsApp: when this person first received a message of the campaign.
        - format `date-time`
      - `errorCode` (`raiz.campaigns.start.response.200.data.recipients.data.errorCode`; string | null, required) — Why the recipient failed, or why its latest message did not arrive while it waits for a retry: `NO_ANSWER` when nobody answered, `CALL_REJECTED` when the call could not be placed, `CALL_FAILED` when it did not achieve its goal, `CONTACT_SUPPRESSED` when a suppression rule forbids the number, a `WHATSAPP_*` code on WhatsApp.
      - `familyName` (`raiz.campaigns.start.response.200.data.recipients.data.familyName`; string | null, required)
      - `firstMessage` (`raiz.campaigns.start.response.200.data.recipients.data.firstMessage`; string | null, required)
      - `givenName` (`raiz.campaigns.start.response.200.data.recipients.data.givenName`; string | null, required)
      - `id` (`raiz.campaigns.start.response.200.data.recipients.data.id`; string, required) — Campaign recipient id.
        - pattern `^rcp_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$`
      - `instructions` (`raiz.campaigns.start.response.200.data.recipients.data.instructions`; string | null, required)
      - `lastAttempt` (`raiz.campaigns.start.response.200.data.recipients.data.lastAttempt`; object | null, required) — The latest call or message to this recipient, or their answer when it came after that conversation closed; its transcript is `getConversation`.
        - `conversationId` (`raiz.campaigns.start.response.200.data.recipients.data.lastAttempt.conversationId`; string, required) — Conversation id.
          - pattern `^cnv_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$`
        - `outcome` (`raiz.campaigns.start.response.200.data.recipients.data.lastAttempt.outcome`; string | null, required)
          - one of `"success"`, `"failure"`, `"unknown"`, `null`
        - `startedAt` (`raiz.campaigns.start.response.200.data.recipients.data.lastAttempt.startedAt`; string, required) — An instant in RFC 3339 format, in UTC.
          - format `date-time`
        - `status` (`raiz.campaigns.start.response.200.data.recipients.data.lastAttempt.status`; string, required)
          - one of `"open"`, `"closed"`
      - `nextAttemptAt` (`raiz.campaigns.start.response.200.data.recipients.data.nextAttemptAt`; string | null, required) — An instant in RFC 3339 format, in UTC.
        - format `date-time`
      - `readAt` (`raiz.campaigns.start.response.200.data.recipients.data.readAt`; string | null, required) — WhatsApp: when this person first read a message of the campaign. Some people turn read receipts off.
        - format `date-time`
      - `repliedAt` (`raiz.campaigns.start.response.200.data.recipients.data.repliedAt`; string | null, required) — WhatsApp: when this person first replied.
        - format `date-time`
      - `results` (`raiz.campaigns.start.response.200.data.recipients.data.results`; array<object>, required) — What this person answered, from their conversations: the latest for each data definition with options their Agent collects. Empty until a conversation they answered closes and is analyzed.
        - `definitionKey` (`raiz.campaigns.start.response.200.data.recipients.data.results.definitionKey`; string, required) — The key of the data definition that read it.
        - `label` (`raiz.campaigns.start.response.200.data.recipients.data.results.label`; string, required) — The answer, as people read it.
        - `value` (`raiz.campaigns.start.response.200.data.recipients.data.results.value`; string, required) — The key of the answer's option.
      - `status` (`raiz.campaigns.start.response.200.data.recipients.data.status`; string, required) — `pending`: waiting for its (next) call or message. `in_progress`: being called, or on WhatsApp waiting for a reply until a reminder is due. `completed`: a call succeeded or ended normally with an inconclusive analysis; on WhatsApp, the message arrived. `failed`: its attempts ran out, or it cannot be reached.
        - one of `"pending"`, `"in_progress"`, `"completed"`, `"failed"`, `"cancelled"`
      - `updatedAt` (`raiz.campaigns.start.response.200.data.recipients.data.updatedAt`; string, required) — An instant in RFC 3339 format, in UTC.
        - format `date-time`
      - `variables` (`raiz.campaigns.start.response.200.data.recipients.data.variables`; object, required) — Values for the `{{name}}` variables a WhatsApp template's parameters, or the Agent's instructions, first message or this campaign's texts on a call, reference. A reference means the variable that is the same word, whatever its accents and case: `{{País}}` reads `pais`, and an exact name wins. Raíz always provides `contact_name`, `contact_given_name` and `contact_phone`, and on a call also `contact_id`, `conversation_id` and `bulletins` (the business bulletins in force); a recipient's values never replace them.
    - `object` (`raiz.campaigns.start.response.200.data.recipients.object`; string, required) — Discriminator for a resource list response.
    - `pageInfo` (`raiz.campaigns.start.response.200.data.recipients.pageInfo`; object, required) — Opaque navigation cursors for this page’s stable keyset order.
      - `hasNextPage` (`raiz.campaigns.start.response.200.data.recipients.pageInfo.hasNextPage`; boolean, required) — Whether a later page exists in the current ordering.
      - `hasPreviousPage` (`raiz.campaigns.start.response.200.data.recipients.pageInfo.hasPreviousPage`; boolean, required) — Whether an earlier page exists in the current ordering.
      - `nextCursor` (`raiz.campaigns.start.response.200.data.recipients.pageInfo.nextCursor`; string | null, required) — Opaque cursor for the next page, or null when there is none.
      - `previousCursor` (`raiz.campaigns.start.response.200.data.recipients.pageInfo.previousCursor`; string | null, required) — Opaque cursor for the previous page, or null when there is none.
  - `results` (`raiz.campaigns.start.response.200.data.results`; array<object>, optional) — What people answered, for each data definition with options their Agent collects that has an answer yet. Answers arrive when a conversation closes and is analyzed, so they can keep arriving after the campaign ends.
    - `definition` (`raiz.campaigns.start.response.200.data.results.definition`; object, required)
      - `key` (`raiz.campaigns.start.response.200.data.results.definition.key`; string, required)
      - `name` (`raiz.campaigns.start.response.200.data.results.definition.name`; string, required)
    - `values` (`raiz.campaigns.start.response.200.data.results.values`; array<object>, required)
      - `key` (`raiz.campaigns.start.response.200.data.results.values.key`; string, required) — The key of the answer's option.
      - `label` (`raiz.campaigns.start.response.200.data.results.values.label`; string, required) — The answer, as people read it.
      - `people` (`raiz.campaigns.start.response.200.data.results.values.people`; integer, required) — How many recipients it is the latest answer of. Each counts once, however many conversations they had.
        - min 1
- `error` (`raiz.campaigns.start.response.200.error`; unknown, required)
- `metadata` (`raiz.campaigns.start.response.200.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.200.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 400

- `INVALID_INPUT`: The request does not match the published schema.
- `INVALID_CURSOR`: The cursor is malformed or belongs to a different list.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INVALID_INPUT",
    "message": "string",
    "retryable": false,
    "data": {
      "issues": [
        {
          "path": "string",
          "message": "string"
        }
      ]
    }
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.400.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.400.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.400.error`; RaizStartCampaignBadRequestFailure, required)
  - one of: `InvalidInputFailure`, `RaizInvalidCursorFailure`
  - discriminator: `code`
- `metadata` (`raiz.campaigns.start.response.400.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.400.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 401

`UNAUTHORIZED`: A valid access token is required.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.401.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.401.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.401.error`; object, required) — A valid access token is required.
  - `code` (`raiz.campaigns.start.response.401.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNAUTHORIZED"`
  - `message` (`raiz.campaigns.start.response.401.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`raiz.campaigns.start.response.401.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`raiz.campaigns.start.response.401.error.data`; object, required) — No fields.
- `metadata` (`raiz.campaigns.start.response.401.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.401.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 402

`CREDITS_EXHAUSTED`: The organization's credits do not cover this, so nothing was started. Try again once the organization adds credits.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "CREDITS_EXHAUSTED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.402.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.402.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.402.error`; object, required) — The organization's credits do not cover this, so nothing was started. Try again once the organization adds credits.
  - `code` (`raiz.campaigns.start.response.402.error.code`; string, required) — The failure code, stable across releases.
    - one of `"CREDITS_EXHAUSTED"`
  - `message` (`raiz.campaigns.start.response.402.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`raiz.campaigns.start.response.402.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`raiz.campaigns.start.response.402.error.data`; object, required) — No fields.
- `metadata` (`raiz.campaigns.start.response.402.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.402.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 403

`FORBIDDEN`: The token does not authorize this operation.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "FORBIDDEN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.403.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.403.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.403.error`; object, required) — The token does not authorize this operation.
  - `code` (`raiz.campaigns.start.response.403.error.code`; string, required) — The failure code, stable across releases.
    - one of `"FORBIDDEN"`
  - `message` (`raiz.campaigns.start.response.403.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`raiz.campaigns.start.response.403.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`raiz.campaigns.start.response.403.error.data`; object, required) — No fields.
- `metadata` (`raiz.campaigns.start.response.403.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.403.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 404

- `TEMPLATE_NOT_FOUND`: The template does not exist in this channel's WhatsApp Business Account.
- `RESOURCE_NOT_FOUND`: The requested resource does not exist in this organization.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "TEMPLATE_NOT_FOUND",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.404.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.404.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.404.error`; RaizStartCampaignNotFoundFailure, required)
  - one of: `RaizTemplateNotFoundFailure`, `RaizResourceNotFoundFailure`
  - discriminator: `code`
- `metadata` (`raiz.campaigns.start.response.404.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.404.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 409

- `CAMPAIGN_AGENT_NOT_READY`: The campaign's Agent must be an active text Agent: it answers whoever replies to the message.
- `CAMPAIGN_NO_RECIPIENTS`: The campaign has nobody left to reach. Add recipients first.
- `CHANNEL_NOT_READY`: The channel is not connected yet, or this kind of traffic is not enabled on it.
- `CHANNEL_TYPE_MISMATCH`: This operation or field does not apply to this channel's type.
- `TEMPLATE_NOT_APPROVED`: The template is not approved for sending: it is pending review, rejected, paused or disabled.
- `VOICE_AGENT_NOT_READY`: The Agent cannot take calls yet: it must be an active voice Agent with instructions, published for calls.
- `INVALID_STATE`: The resource is not in a state that allows this operation.
- `VERSION_CONFLICT`: The resource changed after it was read. Read it again and retry with the new version.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "CAMPAIGN_AGENT_NOT_READY",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.409.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.409.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.409.error`; RaizStartCampaignConflictFailure, required)
  - one of: `RaizCampaignAgentNotReadyFailure`, `RaizCampaignNoRecipientsFailure`, `RaizChannelNotReadyFailure`, `RaizChannelTypeMismatchFailure`, `RaizTemplateNotApprovedFailure`, `RaizVoiceAgentNotReadyFailure`, `RaizInvalidStateFailure`, `RaizVersionConflictFailure`
  - discriminator: `code`
- `metadata` (`raiz.campaigns.start.response.409.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.409.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 413

`REQUEST_TOO_LARGE`: The request exceeds the allowed size.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "REQUEST_TOO_LARGE",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.413.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.413.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.413.error`; object, required) — The request exceeds the allowed size.
  - `code` (`raiz.campaigns.start.response.413.error.code`; string, required) — The failure code, stable across releases.
    - one of `"REQUEST_TOO_LARGE"`
  - `message` (`raiz.campaigns.start.response.413.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`raiz.campaigns.start.response.413.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`raiz.campaigns.start.response.413.error.data`; object, required) — No fields.
- `metadata` (`raiz.campaigns.start.response.413.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.413.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 415

`UNSUPPORTED_MEDIA_TYPE`: The request content type is not supported.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.415.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.415.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.415.error`; object, required) — The request content type is not supported.
  - `code` (`raiz.campaigns.start.response.415.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNSUPPORTED_MEDIA_TYPE"`
  - `message` (`raiz.campaigns.start.response.415.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`raiz.campaigns.start.response.415.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`raiz.campaigns.start.response.415.error.data`; object, required) — No fields.
- `metadata` (`raiz.campaigns.start.response.415.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.415.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 422

- `CAMPAIGN_HEADER_MISSING`: A recipient has no file that fits the template's header (a PDF for a document, JPEG or PNG for an image, MP4 for a video). Each recipient brings its own as `header`.
- `CAMPAIGN_VARIABLE_MISSING`: A recipient has no value for a variable the template's parameters use. An empty value cannot be sent on WhatsApp.
- `CHANNEL_AGENT_MISMATCH`: This Agent cannot serve this channel: voice channels need a voice Agent; WhatsApp and web channels need a text Agent.
- `TEMPLATE_HEADER_MISMATCH`: The header file does not fit the template: a document header takes a PDF, an image header a JPEG or PNG, a video header an MP4, and a template without a media header takes no file.
- `TEMPLATE_HEADER_REQUIRED`: The template's header is a document, image or video: send its file with the template.
- `TEMPLATE_PARAMETERS_MISMATCH`: The number of parameters does not match the variables of the template's body.
- `TEMPLATE_UNSUPPORTED`: The template needs header text variables, a location header or button parameters, which cannot be sent yet.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "CAMPAIGN_HEADER_MISSING",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.422.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.422.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.422.error`; RaizStartCampaignUnprocessableContentFailure, required)
  - one of: `RaizCampaignHeaderMissingFailure`, `RaizCampaignVariableMissingFailure`, `RaizChannelAgentMismatchFailure`, `RaizTemplateHeaderMismatchFailure`, `RaizTemplateHeaderRequiredFailure`, `RaizTemplateParametersMismatchFailure`, `RaizTemplateUnsupportedFailure`
  - discriminator: `code`
- `metadata` (`raiz.campaigns.start.response.422.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.422.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 429

`RATE_LIMITED`: The request rate limit was exceeded. Try again later.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RATE_LIMITED",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.429.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.429.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.429.error`; object, required) — The request rate limit was exceeded. Try again later.
  - `code` (`raiz.campaigns.start.response.429.error.code`; string, required) — The failure code, stable across releases.
    - one of `"RATE_LIMITED"`
  - `message` (`raiz.campaigns.start.response.429.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`raiz.campaigns.start.response.429.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`raiz.campaigns.start.response.429.error.data`; object, required) — No fields.
- `metadata` (`raiz.campaigns.start.response.429.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.429.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 500

`INTERNAL_ERROR`: The service could not complete the operation.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.500.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.500.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.500.error`; object, required) — The service could not complete the operation.
  - `code` (`raiz.campaigns.start.response.500.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INTERNAL_ERROR"`
  - `message` (`raiz.campaigns.start.response.500.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`raiz.campaigns.start.response.500.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`raiz.campaigns.start.response.500.error.data`; object, required) — No fields.
- `metadata` (`raiz.campaigns.start.response.500.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.500.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 502

`OUTCOME_UNKNOWN`: The operation may have been applied; check its result before repeating it.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "OUTCOME_UNKNOWN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.502.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.502.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.502.error`; object, required) — The operation may have been applied; check its result before repeating it.
  - `code` (`raiz.campaigns.start.response.502.error.code`; string, required) — The failure code, stable across releases.
    - one of `"OUTCOME_UNKNOWN"`
  - `message` (`raiz.campaigns.start.response.502.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`raiz.campaigns.start.response.502.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`raiz.campaigns.start.response.502.error.data`; object, required) — No fields.
- `metadata` (`raiz.campaigns.start.response.502.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.502.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 503

`UPSTREAM_UNAVAILABLE`: The upstream service could not complete the request.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_UNAVAILABLE",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.503.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.503.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.503.error`; object, required) — The upstream service could not complete the request.
  - `code` (`raiz.campaigns.start.response.503.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UPSTREAM_UNAVAILABLE"`
  - `message` (`raiz.campaigns.start.response.503.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`raiz.campaigns.start.response.503.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`raiz.campaigns.start.response.503.error.data`; object, required) — No fields.
- `metadata` (`raiz.campaigns.start.response.503.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.503.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 504

`UPSTREAM_TIMEOUT`: The upstream service did not respond before its deadline.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_TIMEOUT",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`raiz.campaigns.start.response.504.success`; boolean, required)
  - one of `false`
- `data` (`raiz.campaigns.start.response.504.data`; unknown, required)
- `error` (`raiz.campaigns.start.response.504.error`; object, required) — The upstream service did not respond before its deadline.
  - `code` (`raiz.campaigns.start.response.504.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UPSTREAM_TIMEOUT"`
  - `message` (`raiz.campaigns.start.response.504.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`raiz.campaigns.start.response.504.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`raiz.campaigns.start.response.504.error.data`; object, required) — No fields.
- `metadata` (`raiz.campaigns.start.response.504.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`raiz.campaigns.start.response.504.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.


Source: https://docs.getarbol.com/api/raiz/campaigns/start/index.md
