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
https://api.getarbol.com/v1/raiz/campaigns/{campaignId}/startAuthorization
Path parameters
Request body JSON required
Returns
200
Successful operation.
400
INVALID_INPUT: The request does not match the published schema.INVALID_CURSOR: The cursor is malformed or belongs to a different list.
401
UNAUTHORIZED: A valid access token is required.
402
CREDITS_EXHAUSTED: The organization's credits do not cover this, so nothing was started. Try again once the organization adds credits.
403
FORBIDDEN: The token does not authorize this operation.
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.
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.
413
REQUEST_TOO_LARGE: The request exceeds the allowed size.
415
UNSUPPORTED_MEDIA_TYPE: The request content type is not supported.
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 asheader.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.