Campaigns

API reference descriptions are provided in English to preserve the exact published contract.

GETList resumable campaign builder draftscampaignBuilderDrafts.list
POSTCreate a resumable campaign builder draftcampaignBuilderDrafts.create
POSTStart or resume a campaign from an approved templatecampaignBuilderDrafts.fromTemplate
GETFetch a campaign builder draftcampaignBuilderDrafts.retrieve
PATCHSave campaign builder progresscampaignBuilderDrafts.update
DELETEDelete a campaign builder draftcampaignBuilderDrafts.delete
POSTPreview current consent and suppression for one observed saved-draft audience slicecampaignBuilderDrafts.consentPreview
GETList campaigns and authoritative planning statecampaigns.list
POSTCreate a campaign draftcampaigns.create
GETFetch a campaigncampaigns.retrieve
DELETEDelete a campaign draftcampaigns.delete
POSTApprove a campaigncampaigns.approve
POSTRecord an idempotent campaign click or conversioncampaigns.attributionEvents
GETList campaign planning batchescampaigns.batches.list
POSTCancel a campaigncampaigns.cancel
PATCHSet the frequency policy, money budget cap, account pacing and transportcampaigns.controls.update
POSTDry-run campaign admissioncampaigns.dryRun
GETList campaign exclusionscampaigns.exclusions.list
GETRead campaign experiment, holdout and attribution configurationcampaigns.experiment.list
PUTConfigure deterministic campaign variants and holdoutcampaigns.experiment.update
GETReport campaign outcomes and cost by variant with honest denominatorscampaigns.experimentReport.list
POSTPause a campaigncampaigns.pause
GETRead owned campaign retained performancecampaigns.performance.list
POSTReject a campaigncampaigns.reject
POSTResume a campaigncampaigns.resume
POSTCreate a draft campaign for retryable failed recipientscampaigns.retryEligible
GETEvaluate the current campaign authorization decision without mutating itcampaigns.review.list
POSTAcknowledge an allowed campaign review snapshotcampaigns.review.acknowledge
PATCHEdit a draft or scheduled campaign windowcampaigns.schedule.update
POSTStart a campaigncampaigns.start
POSTSubmit a campaigncampaigns.submit
POSTSend a billed campaign sample to at most 10 contactscampaigns.testSend
POSTWithdraw a pending campaign approval requestcampaigns.withdraw

List resumable campaign builder drafts

GET/v1/accounts/{AC}/campaign-builder-drafts

campaignBuilderDrafts.listSDK operation getV1AccountsByAcCampaignBuilderDrafts

Required scope: campaigns:read.Paginated

Parameters

limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/campaign-builder-drafts

curl "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaign-builder-drafts" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Create a resumable campaign builder draft

POST/v1/accounts/{AC}/campaign-builder-drafts

campaignBuilderDrafts.createSDK operation postV1AccountsByAcCampaignBuilderDrafts

Required scope: campaigns:write.Idempotency-Key required

Request body

currentStepinteger (1–9)Required
dataobjectRequired
namestring (max 256 chars)Required
versioninteger (1–)

POST /v1/accounts/{AC}/campaign-builder-drafts

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaign-builder-drafts" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "currentStep": 1,
  "data": {},
  "name": "string"
}'

Responses

Start or resume a campaign from an approved template

POST/v1/accounts/{AC}/campaign-builder-drafts/from-template

campaignBuilderDrafts.fromTemplateSDK operation postV1AccountsByAcCampaignBuilderDraftsFromTemplate

Required scope: campaigns:write.Idempotency-Key required

Request body

templateSidstring (TM… SID)Required

POST /v1/accounts/{AC}/campaign-builder-drafts/from-template

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaign-builder-drafts/from-template" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "templateSid": "TM..."
}'

Responses

Fetch a campaign builder draft

GET/v1/accounts/{AC}/campaign-builder-drafts/{CD}

campaignBuilderDrafts.retrieveSDK operation getV1AccountsByAcCampaignBuilderDraftsByCd

Required scope: campaigns:read.

Parameters

CDstring (CD… SID)Required

GET /v1/accounts/{AC}/campaign-builder-drafts/{CD}

curl "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaign-builder-drafts/CD..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Save campaign builder progress

PATCH/v1/accounts/{AC}/campaign-builder-drafts/{CD}

campaignBuilderDrafts.updateSDK operation patchV1AccountsByAcCampaignBuilderDraftsByCd

Required scope: campaigns:write.Idempotency-Key required

Parameters

CDstring (CD… SID)Required

Request body

currentStepinteger (1–9)Required
dataobjectRequired
namestring (max 256 chars)Required
versioninteger (1–)

PATCH /v1/accounts/{AC}/campaign-builder-drafts/{CD}

curl -X PATCH "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaign-builder-drafts/CD..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "currentStep": 1,
  "data": {},
  "name": "string"
}'

Responses

Delete a campaign builder draft

DELETE/v1/accounts/{AC}/campaign-builder-drafts/{CD}

campaignBuilderDrafts.deleteSDK operation deleteV1AccountsByAcCampaignBuilderDraftsByCd

Required scope: campaigns:write.

Parameters

CDstring (CD… SID)Required

DELETE /v1/accounts/{AC}/campaign-builder-drafts/{CD}

curl -X DELETE "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaign-builder-drafts/CD..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Preview current consent and suppression for one observed saved-draft audience slice

POST/v1/accounts/{AC}/campaign-builder-drafts/{CD}/consent-preview

campaignBuilderDrafts.consentPreviewSDK operation postV1AccountsByAcCampaignBuilderDraftsByCdConsentPreview

Required scope: campaigns:write.Idempotency-Key required

Parameters

CDstring (CD… SID)Required

Request body

expectedVersioninteger (1–9007199254740991)Required
cursorstring (max 4096 chars)
limitinteger (1–100)

POST /v1/accounts/{AC}/campaign-builder-drafts/{CD}/consent-preview

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaign-builder-drafts/CD.../consent-preview" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "expectedVersion": 1
}'

Responses

List campaigns and authoritative planning state

GET/v1/accounts/{AC}/campaigns

campaigns.listSDK operation getV1AccountsByAcCampaigns

List campaigns with their state and planning progress.

Required scope: campaigns:read.Paginated

Parameters

limitinteger (1–100)query
cursorstring (max 2048 chars)query
stateenumquery
DRAFTPENDING_APPROVALSCHEDULEDPLANNINGRUNNINGPAUSEDCOMPLETINGCOMPLETEDCANCELEDFAILED

GET /v1/accounts/{AC}/campaigns

curl "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Create a campaign draft

POST/v1/accounts/{AC}/campaigns

campaigns.createSDK operation postV1AccountsByAcCampaigns

Create a campaign draft: who receives which template, when, and how fast. Nothing is sent until the campaign is started.

Required scope: campaigns:write.Idempotency-Key required

Request body

audienceobjectRequired
contentSidstring (HX… SID)Required
namestring (max 256 chars)Required
pacingobjectRequired
Show 2 child attributes
- perSenderPerMinuteinteger (1–1000000)Required
- perAccountPerMinuteinteger (1–1000000)
scheduleobjectRequired
Show 4 child attributes
- endAtstring (date-time)Required
- startAtstring (date-time)Required
- quietHoursobject
- timezoneModeenum
  senderrecipient
budgetCapstring (pattern ^[0-9][0-9,]*(\.[0-9]+)?$, max 24 chars)
Budget cap in the campaign currency's own units, for example "500" for JPY or "12.50" for GBP.
budgetCapMinorinteger (0–)
builderDraftSidstring (CD… SID)
builderDraftVersioninteger (1–9007199254740991)
Saved builder draft version, required for first materialization with builderDraftSid. Retries of an already converted owned, unexpired draft return its existing campaign.
currencystring (pattern ^[A-Z]{3}$)
frequencyPolicyobject | null
headerMediaSidstring (ME… SID)
Media sent as the header of an IMAGE, VIDEO or DOCUMENT template. Meta needs the header asset on every send; without this the asset the template was submitted with is used, and a campaign with neither cannot be submitted.
requiresApprovalboolean
senderPoolSidstring (SP… SID)
senderSidsstring (WA… SID)[]
transportenum
cloud_apimarketing_messages
variablesMappingobject
Template placeholder → source. A source is a contact field path (displayName, locale, timezone, attributes.<key>) or literal:<text> for a fixed value; a placeholder with no entry reads attributes.<placeholder>. A contact whose sources resolve to no scalar is excluded with ADDRESSING_UNSUPPORTED and the failing placeholder in detail.

POST /v1/accounts/{AC}/campaigns

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "audience": {},
  "contentSid": "HX...",
  "name": "string",
  "pacing": {
    "perSenderPerMinute": 1
  },
  "schedule": {
    "endAt": "2026-10-25T09:00:00Z",
    "startAt": "2026-10-25T09:00:00Z"
  }
}'

Responses

Fetch a campaign

GET/v1/accounts/{AC}/campaigns/{CP}

campaigns.retrieveSDK operation getV1AccountsByAcCampaignsByCp

Fetch one campaign with its schedule, audience, counts and cost so far.

Required scope: campaigns:read.

Parameters

CPstring (CP… SID)Required

GET /v1/accounts/{AC}/campaigns/{CP}

curl "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Delete a campaign draft

DELETE/v1/accounts/{AC}/campaigns/{CP}

campaigns.deleteSDK operation deleteV1AccountsByAcCampaignsByCp

Required scope: campaigns:write.

Parameters

CPstring (CP… SID)Required

DELETE /v1/accounts/{AC}/campaigns/{CP}

curl -X DELETE "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Approve a campaign

POST/v1/accounts/{AC}/campaigns/{CP}/approve

campaigns.approveSDK operation postV1AccountsByAcCampaignsByCpApprove

Required scope: approvals:decide.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

reasonstring (max 512 chars)

POST /v1/accounts/{AC}/campaigns/{CP}/approve

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../approve" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Record an idempotent campaign click or conversion

POST/v1/accounts/{AC}/campaigns/{CP}/attribution-events

campaigns.attributionEventsSDK operation postV1AccountsByAcCampaignsByCpAttributionEvents

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

eventTypeenumRequired
clickconversion
externalEventIdstring (max 200 chars)Required
occurredAtstring (date-time)Required
contactSidstring (CT… SID)
currencystring (pattern ^[A-Z]{3}$)
messageSidstring (SM… SID)
propertiesobject
valueMinorinteger (0–)

POST /v1/accounts/{AC}/campaigns/{CP}/attribution-events

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../attribution-events" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "eventType": "click",
  "externalEventId": "string",
  "occurredAt": "2026-10-25T09:00:00Z"
}'

Responses

List campaign planning batches

GET/v1/accounts/{AC}/campaigns/{CP}/batches

campaigns.batches.listSDK operation getV1AccountsByAcCampaignsByCpBatches

Required scope: campaigns:read.Paginated

Parameters

CPstring (CP… SID)Required
limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/campaigns/{CP}/batches

curl "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../batches" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Cancel a campaign

POST/v1/accounts/{AC}/campaigns/{CP}/cancel

campaigns.cancelSDK operation postV1AccountsByAcCampaignsByCpCancel

Cancel a campaign. Recipients not yet sent to are skipped; this cannot be undone.

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

reasonstring (max 512 chars)

POST /v1/accounts/{AC}/campaigns/{CP}/cancel

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../cancel" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Set the frequency policy, money budget cap, account pacing and transport

PATCH/v1/accounts/{AC}/campaigns/{CP}/controls

campaigns.controls.updateSDK operation patchV1AccountsByAcCampaignsByCpControls

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

budgetCapstring (pattern ^[0-9][0-9,]*(\.[0-9]+)?$, max 24 chars) | null
budgetCapMinorinteger (0–) | null
frequencyPolicyobject | null
headerMediaSidstring (ME… SID) | null
perAccountPerMinuteinteger (1–1000000) | null
transportenum
cloud_apimarketing_messages

PATCH /v1/accounts/{AC}/campaigns/{CP}/controls

curl -X PATCH "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../controls" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Dry-run campaign admission

POST/v1/accounts/{AC}/campaigns/{CP}/dry-run

campaigns.dryRunSDK operation postV1AccountsByAcCampaignsByCpDryRun

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

reasonstring (max 512 chars)

POST /v1/accounts/{AC}/campaigns/{CP}/dry-run

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../dry-run" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

List campaign exclusions

GET/v1/accounts/{AC}/campaigns/{CP}/exclusions

campaigns.exclusions.listSDK operation getV1AccountsByAcCampaignsByCpExclusions

Required scope: campaigns:read.Paginated

Parameters

CPstring (CP… SID)Required
limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/campaigns/{CP}/exclusions

curl "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../exclusions" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Read campaign experiment, holdout and attribution configuration

GET/v1/accounts/{AC}/campaigns/{CP}/experiment

campaigns.experiment.listSDK operation getV1AccountsByAcCampaignsByCpExperiment

Required scope: campaigns:read.

Parameters

CPstring (CP… SID)Required

GET /v1/accounts/{AC}/campaigns/{CP}/experiment

curl "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../experiment" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Configure deterministic campaign variants and holdout

PUT/v1/accounts/{AC}/campaigns/{CP}/experiment

campaigns.experiment.updateSDK operation putV1AccountsByAcCampaignsByCpExperiment

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

attributionWindowDaysinteger (1–90)Required
enabledbooleanRequired
holdoutBasisPointsinteger (0–5000)Required
primaryEventenumRequired
clickconversion
variantsobject[]Required

PUT /v1/accounts/{AC}/campaigns/{CP}/experiment

curl -X PUT "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../experiment" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "attributionWindowDays": 1,
  "enabled": true,
  "holdoutBasisPoints": 0,
  "primaryEvent": "click",
  "variants": []
}'

Responses

Report campaign outcomes and cost by variant with honest denominators

GET/v1/accounts/{AC}/campaigns/{CP}/experiment-report

campaigns.experimentReport.listSDK operation getV1AccountsByAcCampaignsByCpExperimentReport

Required scope: campaigns:read.

Parameters

CPstring (CP… SID)Required

GET /v1/accounts/{AC}/campaigns/{CP}/experiment-report

curl "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../experiment-report" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Pause a campaign

POST/v1/accounts/{AC}/campaigns/{CP}/pause

campaigns.pauseSDK operation postV1AccountsByAcCampaignsByCpPause

Pause a running campaign. Messages already handed to WhatsApp still deliver.

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

reasonstring (max 512 chars)

POST /v1/accounts/{AC}/campaigns/{CP}/pause

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../pause" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Read owned campaign retained performance

GET/v1/accounts/{AC}/campaigns/{CP}/performance

campaigns.performance.listSDK operation getV1AccountsByAcCampaignsByCpPerformance

Required scope: campaigns:read.Additionally, every one of these scopes is required: campaigns:read, analytics:read.

Parameters

CPstring (CP… SID)Required
fromstring (date-time)query
tostring (date-time)query

GET /v1/accounts/{AC}/campaigns/{CP}/performance

curl "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../performance" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Reject a campaign

POST/v1/accounts/{AC}/campaigns/{CP}/reject

campaigns.rejectSDK operation postV1AccountsByAcCampaignsByCpReject

Required scope: approvals:decide.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

reasonstring (max 512 chars)

POST /v1/accounts/{AC}/campaigns/{CP}/reject

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../reject" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Resume a campaign

POST/v1/accounts/{AC}/campaigns/{CP}/resume

campaigns.resumeSDK operation postV1AccountsByAcCampaignsByCpResume

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

reasonstring (max 512 chars)

POST /v1/accounts/{AC}/campaigns/{CP}/resume

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../resume" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Create a draft campaign for retryable failed recipients

POST/v1/accounts/{AC}/campaigns/{CP}/retry-eligible

campaigns.retryEligibleSDK operation postV1AccountsByAcCampaignsByCpRetryEligible

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

namestring (max 256 chars)

POST /v1/accounts/{AC}/campaigns/{CP}/retry-eligible

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../retry-eligible" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Evaluate the current campaign authorization decision without mutating it

GET/v1/accounts/{AC}/campaigns/{CP}/review

campaigns.review.listSDK operation getV1AccountsByAcCampaignsByCpReview

Required scope: campaigns:read.

Parameters

CPstring (CP… SID)Required

GET /v1/accounts/{AC}/campaigns/{CP}/review

curl "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../review" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Acknowledge an allowed campaign review snapshot

POST/v1/accounts/{AC}/campaigns/{CP}/review/acknowledge

campaigns.review.acknowledgeSDK operation postV1AccountsByAcCampaignsByCpReviewAcknowledge

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

acknowledgeCostbooleanRequired
acknowledgeLivebooleanRequired

POST /v1/accounts/{AC}/campaigns/{CP}/review/acknowledge

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../review/acknowledge" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "acknowledgeCost": true,
  "acknowledgeLive": true
}'

Responses

Edit a draft or scheduled campaign window

PATCH/v1/accounts/{AC}/campaigns/{CP}/schedule

campaigns.schedule.updateSDK operation patchV1AccountsByAcCampaignsByCpSchedule

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

endAtstring (date-time)Required
startAtstring (date-time)Required
timezoneModeenumRequired
senderrecipient
perSenderPerMinuteinteger (1–1000000)
quietHoursobject | null

PATCH /v1/accounts/{AC}/campaigns/{CP}/schedule

curl -X PATCH "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../schedule" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "endAt": "2026-10-25T09:00:00Z",
  "startAt": "2026-10-25T09:00:00Z",
  "timezoneMode": "sender"
}'

Responses

Start a campaign

POST/v1/accounts/{AC}/campaigns/{CP}/start

campaigns.startSDK operation postV1AccountsByAcCampaignsByCpStart

Start a campaign. It must have passed review; a campaign that needs approval waits for it.

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

reasonstring (max 512 chars)

POST /v1/accounts/{AC}/campaigns/{CP}/start

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../start" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Submit a campaign

POST/v1/accounts/{AC}/campaigns/{CP}/submit

campaigns.submitSDK operation postV1AccountsByAcCampaignsByCpSubmit

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

reasonstring (max 512 chars)

POST /v1/accounts/{AC}/campaigns/{CP}/submit

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../submit" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Send a billed campaign sample to at most 10 contacts

POST/v1/accounts/{AC}/campaigns/{CP}/test-send

campaigns.testSendSDK operation postV1AccountsByAcCampaignsByCpTestSend

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

Request body

contactSidsstring (CT… SID)[]Required

POST /v1/accounts/{AC}/campaigns/{CP}/test-send

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../test-send" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "contactSids": "CT..."
}'

Responses

Withdraw a pending campaign approval request

POST/v1/accounts/{AC}/campaigns/{CP}/withdraw

campaigns.withdrawSDK operation postV1AccountsByAcCampaignsByCpWithdraw

Required scope: campaigns:write.Idempotency-Key required

Parameters

CPstring (CP… SID)Required

POST /v1/accounts/{AC}/campaigns/{CP}/withdraw

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/campaigns/CP.../withdraw" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses