Skip to content
Navigation

Start a campaign

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
POST
https://api.getarbol.com/v1/raiz/campaigns/{campaignId}/start

Authorization

  • Authorization
    string
    required
    Bearer <token>, where the token is an API key, a client-credentials token or a person's access token with the scope raiz:campaigns:write. Get an API key.

Path parameters

  • 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 JSON required

Returns

200

Successful operation.

JSON
  • success
    true
    required
  • data
    object
    required
    • 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
      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
      voice
      or
      whatsapp
      required

      How the campaign reaches people: by call or by WhatsApp.

    • contactHours
      array of
      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
        array of
        MO
        or
        TU
        or
        WE
        or
        TH
        or
        FR
        or
        SA
        +1 more
        required
      • from
        string
        required

        Local start time, HH:MM, inclusive.

        pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$
      • 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
      string
      required

      An instant in RFC 3339 format, in UTC.

      format: date-time
    • endedAt
      string | null
      required

      An instant in RFC 3339 format, in UTC.

      format: date-time
    • errorAt
      string | null
      required

      When errorCode was first seen.

      format: date-time
    • 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
      string | null
      required
    • 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
      string | null
      required
    • maxAttempts
      integer
      required
      maximum: 10 · minimum: 1
    • 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
      string
      required
    • progress
      object
      required

      How many recipients are in each state.

      • answered
        integer
        required

        Calls: recipients whose latest call someone answered and its analysis judged.

        minimum: 0
      • buttons
        array of
        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
          integer
          required

          How many recipients have it as their last press.

          minimum: 0
        • text
          string
          required

          The button's text, as the template shows it.

          maxLength: 256 · minLength: 1
      • completed
        integer
        required
        minimum: 0
      • delivered
        integer
        required

        WhatsApp: recipients who received a message.

        minimum: 0
      • failed
        integer
        required
        minimum: 0
      • inProgress
        integer
        required
        minimum: 0
      • noAnswer
        integer
        required

        Calls: recipients who failed because their calls ran out without anyone answering. A voicemail counts here.

        minimum: 0
      • 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.

        minimum: 0
      • noReply
        integer
        required

        WhatsApp: recipients a message reached who neither pressed a button nor wrote: noButton less those who answered in writing.

        minimum: 0
      • pending
        integer
        required
        minimum: 0
      • read
        integer
        required

        WhatsApp: recipients who read a message.

        minimum: 0
      • recipients
        integer
        required
        minimum: 0
      • replied
        integer
        required

        WhatsApp: recipients who replied.

        minimum: 0
      • succeeded
        integer
        required

        Recipients whose latest conversation's analysis judged it successful.

        minimum: 0
    • retryAfterMinutes
      integer
      required
      minimum: 1
    • retryOn
      array of
      no_answer
      or
      failure
      or
      not_delivered
      required
    • scheduledEndAt
      string | null
      required

      An instant in RFC 3339 format, in UTC.

      format: date-time
    • scheduledStartAt
      string | null
      required

      An instant in RFC 3339 format, in UTC.

      format: date-time
    • startedAt
      string | null
      required

      An instant in RFC 3339 format, in UTC.

      format: date-time
    • status
      queued
      or
      running
      or
      paused
      or
      completed
      or
      cancelled
      or
      failed
      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.

    • template
      required

      One of the following:

      • RaizCampaignTemplate
        • language
          string
          required

          The template's language: WhatsApp's code (es, es_MX) or a BCP 47 tag (es-MX).

          maxLength: 15 · minLength: 2
        • name
          string
          required

          An approved template of the line's WhatsApp Business Account. Its body may have variables; when its header is a document, image or video, each recipient brings its own file (header). Button parameters cannot be used in a campaign.

          maxLength: 512 · minLength: 1
        • parameters
          array of
          string
          required

          The template's body parameters, in order. Each is a text that may reference each recipient's variables as {{name}}, for example {{patient_name}} or Dr. {{doctor}}.

          maxLength: 1024
      • null
    • timeZone
      string
      required
    • updatedAt
      string
      required

      An instant in RFC 3339 format, in UTC.

      format: date-time
    • version
      integer
      required
      minimum: 1
    • 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
      optional
      object

      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
        array of
        object
        required

        What has to be fixed first. Empty when it can start.

        • 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
          optional
          string

          The recipient it is about, when it is one.

        • variable
          optional
          string

          The variable it lacks, when it is one.

      • estimate
        object
        required

        What reaching each pending recipient once would cost, checked against the organization's balance without reaching anyone.

        • 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
            integer
            required

            How many of those calls the figure comes from.

            minimum: 0
          • perCall
            number
            required

            Minutes billed per call on average, a call nobody answered counting zero.

            minimum: 0
        • 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
          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.

          minimum: 0
        • degraded
          boolean
          required

          Billing did not answer in time: credits may be null, and covered is assumed.

        • 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
          integer
          required

          The recipients still to be reached, each counted once.

          minimum: 0
      • preview
        string | null
        required

        WhatsApp: the message as the first pending recipient would read it. Null when it cannot be told yet.

      • ready
        boolean
        required

        Whether startCampaign would accept it now.

    • recipients
      optional
      object

      The campaign's recipients in the order they were added, each with its latest attempt. Present only when expanded.

      • data
        array of
        object
        required

        Items admitted by this resource contract within the verified organization.

        • address
          string
          required
        • attemptCount
          integer
          required
          minimum: 0
        • 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
            string
            required

            An instant in RFC 3339 format, in UTC.

            format: date-time
          • text
            string
            required

            The button's text, as the template shows it.

            maxLength: 256 · minLength: 1
        • 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
            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
            string | null
            required

            Their saved name, else the name they show on WhatsApp; null when the organization has neither.

        • 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
          string
          required

          An instant in RFC 3339 format, in UTC.

          format: date-time
        • deliveredAt
          string | null
          required

          WhatsApp: when this person first received a message of the campaign.

          format: date-time
        • 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
          string | null
          required
        • firstMessage
          string | null
          required
        • givenName
          string | null
          required
        • 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
          string | null
          required
        • 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
            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
            success
            or
            failure
            or
            unknown
            or
            null
            required
          • startedAt
            string
            required

            An instant in RFC 3339 format, in UTC.

            format: date-time
          • status
            open
            or
            closed
            required
        • nextAttemptAt
          string | null
          required

          An instant in RFC 3339 format, in UTC.

          format: date-time
        • 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
          string | null
          required

          WhatsApp: when this person first replied.

          format: date-time
        • results
          array of
          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
            string
            required

            The key of the data definition that read it.

          • label
            string
            required

            The answer, as people read it.

          • value
            string
            required

            The key of the answer's option.

        • status
          pending
          or
          in_progress
          or
          completed
          or
          failed
          or
          cancelled
          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.

        • updatedAt
          string
          required

          An instant in RFC 3339 format, in UTC.

          format: date-time
        • 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
        string
        required

        Discriminator for a resource list response.

      • pageInfo
        object
        required

        Opaque navigation cursors for this page’s stable keyset order.

        • hasNextPage
          boolean
          required

          Whether a later page exists in the current ordering.

        • hasPreviousPage
          boolean
          required

          Whether an earlier page exists in the current ordering.

        • nextCursor
          string | null
          required

          Opaque cursor for the next page, or null when there is none.

        • previousCursor
          string | null
          required

          Opaque cursor for the previous page, or null when there is none.

    • results
      optional
      array of
      object

      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
        object
        required
        • key
          string
          required
        • name
          string
          required
      • values
        array of
        object
        required
        • key
          string
          required

          The key of the answer's option.

        • label
          string
          required

          The answer, as people read it.

        • people
          integer
          required

          How many recipients it is the latest answer of. Each counts once, however many conversations they had.

          minimum: 1
  • error
    unknown
    required
  • metadata
    object
    required

    What every answer carries besides its data or error.

    • 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.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    required

    One of the following:

    • InvalidInputFailure
      INVALID_INPUT
      • code
        INVALID_INPUT
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required
        • issues
          optional
          array of
          object
          • path
            string
            required

            RFC 6901 JSON Pointer to the refused field; empty for the whole input.

            maxLength: 256
          • message
            string
            required
            maxLength: 256
    • RaizInvalidCursorFailure
      INVALID_CURSOR
      • code
        INVALID_CURSOR
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

401

UNAUTHORIZED: A valid access token is required.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    A valid access token is required.

    • code
      UNAUTHORIZED
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • 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.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

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

    • code
      CREDITS_EXHAUSTED
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

403

FORBIDDEN: The token does not authorize this operation.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The token does not authorize this operation.

    • code
      FORBIDDEN
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • 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.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    required

    One of the following:

    • RaizTemplateNotFoundFailure
      TEMPLATE_NOT_FOUND
      • code
        TEMPLATE_NOT_FOUND
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • RaizResourceNotFoundFailure
      RESOURCE_NOT_FOUND
      • code
        RESOURCE_NOT_FOUND
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • 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.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    required

    One of the following:

    • RaizCampaignAgentNotReadyFailure
      CAMPAIGN_AGENT_NOT_READY
      • code
        CAMPAIGN_AGENT_NOT_READY
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • RaizCampaignNoRecipientsFailure
      CAMPAIGN_NO_RECIPIENTS
      • code
        CAMPAIGN_NO_RECIPIENTS
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • RaizChannelNotReadyFailure
      CHANNEL_NOT_READY
      • code
        CHANNEL_NOT_READY
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • RaizChannelTypeMismatchFailure
      CHANNEL_TYPE_MISMATCH
      • code
        CHANNEL_TYPE_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • RaizTemplateNotApprovedFailure
      TEMPLATE_NOT_APPROVED
      • code
        TEMPLATE_NOT_APPROVED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • RaizVoiceAgentNotReadyFailure
      VOICE_AGENT_NOT_READY
      • code
        VOICE_AGENT_NOT_READY
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • RaizInvalidStateFailure
      INVALID_STATE
      • code
        INVALID_STATE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • RaizVersionConflictFailure
      VERSION_CONFLICT
      • code
        VERSION_CONFLICT
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

413

REQUEST_TOO_LARGE: The request exceeds the allowed size.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The request exceeds the allowed size.

    • code
      REQUEST_TOO_LARGE
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

415

UNSUPPORTED_MEDIA_TYPE: The request content type is not supported.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The request content type is not supported.

    • code
      UNSUPPORTED_MEDIA_TYPE
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • 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.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    required

    One of the following:

    • RaizCampaignHeaderMissingFailure
      CAMPAIGN_HEADER_MISSING
      • code
        CAMPAIGN_HEADER_MISSING
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • RaizCampaignVariableMissingFailure
      CAMPAIGN_VARIABLE_MISSING
      • code
        CAMPAIGN_VARIABLE_MISSING
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required
        • address
          string
          required

          The first recipient that lacks the value.

        • variable
          string
          required

          The variable of the template's parameters it lacks.

    • RaizChannelAgentMismatchFailure
      CHANNEL_AGENT_MISMATCH
      • code
        CHANNEL_AGENT_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • RaizTemplateHeaderMismatchFailure
      TEMPLATE_HEADER_MISMATCH
      • code
        TEMPLATE_HEADER_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • RaizTemplateHeaderRequiredFailure
      TEMPLATE_HEADER_REQUIRED
      • code
        TEMPLATE_HEADER_REQUIRED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • RaizTemplateParametersMismatchFailure
      TEMPLATE_PARAMETERS_MISMATCH
      • code
        TEMPLATE_PARAMETERS_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • RaizTemplateUnsupportedFailure
      TEMPLATE_UNSUPPORTED
      • code
        TEMPLATE_UNSUPPORTED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

429

RATE_LIMITED: The request rate limit was exceeded. Try again later.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The request rate limit was exceeded. Try again later.

    • code
      RATE_LIMITED
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      true
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

500

INTERNAL_ERROR: The service could not complete the operation.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The service could not complete the operation.

    • code
      INTERNAL_ERROR
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • 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.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

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

    • code
      OUTCOME_UNKNOWN
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

503

UPSTREAM_UNAVAILABLE: The upstream service could not complete the request.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The upstream service could not complete the request.

    • code
      UPSTREAM_UNAVAILABLE
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      true
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

504

UPSTREAM_TIMEOUT: The upstream service did not respond before its deadline.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The upstream service did not respond before its deadline.

    • code
      UPSTREAM_TIMEOUT
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      true
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

Escribe para buscar…

↑↓ navegar↵ seleccionarEsc cerrar