Contacts

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

POSTRecord the customer's instruction for an action taken on their behalfauthorizations.create
GETHow much of this account's audience you may lawfully messageconsentCoverage.list
GETList contacts or find one by identifiercontacts.list
POSTResolve or create a contact by identifiercontacts.create
POSTRestrict marketing for up to 100 selected contacts with durable per-row resultscontacts.bulkRestrict
GETList open contact identity conflictscontacts.conflicts.list
POSTResolve an identity conflict by merging or dismissing itcontacts.conflicts.resolve
GETList reversible contact merge historycontacts.merges.list
GETGet contact merge recovery detailcontacts.merges.retrieve
POSTReverse a contact merge within its 30-day windowcontacts.merges.revert
GETFetch a contactcontacts.retrieve
PATCHUpdate a contact's profile and attributescontacts.update
GETFull consent historycontacts.consents.list
POSTRecord a consent eventcontacts.consents.create
POSTMerge another contact into this onecontacts.merge
POSTResolve a separate corrected recipient without copying identity history or consentcontacts.recipientCorrections
GETList suppression history for a contactcontacts.suppressions.list
POSTAdd a suppressioncontacts.suppressions.create
DELETERemove a suppressioncontacts.suppressions.delete
GETList audience segmentssegments.list
POSTCreate and materialize an audience segmentsegments.create
POSTPreview typed segment membership without mutationsegments.preview
GETGet a contact segmentsegments.retrieve
PATCHUpdate and rematerialize a segmentsegments.update
DELETEDelete an unused segmentsegments.delete
GETList materialized segment members and provenancesegments.members.list
POSTRefresh dynamic segment membershipsegments.refresh
GETGet the durable service-window state for a sender/contact pairsenders.contacts.window.list
GETList account suppressions with filterssuppressions.list
POSTSuppress a contact by SID or by identifiersuppressions.create
DELETELift suppressions for a contact addressed by SID or identifiersuppressions.delete

Record the customer's instruction for an action taken on their behalf

POST/v1/accounts/{AC}/authorizations

authorizations.createSDK operation postV1AccountsByAcAuthorizations

Meta's Tech Provider terms allow a provider to act only on the customer's instruction. This records one: who gave it, for which task, in their own words. It is written to the append-only audit chain rather than a table of its own, because what an authorisation needs is exactly what that chain already guarantees — attributable, timestamped, and not quietly editable afterwards by either side.

Required scope: contacts:write.Idempotency-Key required

Request body

instructionstring (max 2000 chars)Required
resourceRefstring (max 64 chars)Required
taskenumRequired
DISPLAY_NAME_SUBMISSIONOFFICIAL_BUSINESS_ACCOUNT_APPLICATIONTEMPLATE_SUBMISSIONTEMPLATE_APPEAL

POST /v1/accounts/{AC}/authorizations

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/authorizations" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "instruction": "string",
  "resourceRef": "string",
  "task": "DISPLAY_NAME_SUBMISSION"
}'

Responses

How much of this account's audience you may lawfully message

GET/v1/accounts/{AC}/consent-coverage

consentCoverage.listSDK operation getV1AccountsByAcConsentCoverage

Contacts counted by consent purpose and current status, with the number suppressed. Admission already refuses a marketing send without evidence; this is the same evidence read forward, so a business can see the size of the audience it may actually reach before it builds a campaign around one it may not.

Required scope: contacts:read.

GET /v1/accounts/{AC}/consent-coverage

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

Responses

List contacts or find one by identifier

GET/v1/accounts/{AC}/contacts

contacts.listSDK operation getV1AccountsByAcContacts

List contacts, or find one by phone number or WhatsApp user ID with the identifier filters.

Required scope: contacts:read.Paginated

Parameters

qstring (max 128 chars)query
identifierstring (max 256 chars)query
identifierTypeenumquery
phone_e164bsuidusername
scopeRefstring (max 64 chars)query
limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/contacts

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

Responses

Resolve or create a contact by identifier

POST/v1/accounts/{AC}/contacts

contacts.createSDK operation postV1AccountsByAcContacts

Find the contact with this identifier, or create it. Calling it twice with the same number returns the same contact.

Required scope: contacts:write.Idempotency-Key required

Request body

identifiersobject[]Required
attributesobject
defaultCountrystring (pattern ^[A-Za-z]{2}$)
displayNamestring (max 128 chars)
localestring (max 16 chars)
timezonestring (max 64 chars)

POST /v1/accounts/{AC}/contacts

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/contacts" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "identifiers": []
}'

Responses

Restrict marketing for up to 100 selected contacts with durable per-row results

POST/v1/accounts/{AC}/contacts/bulk-restrict

contacts.bulkRestrictSDK operation postV1AccountsByAcContactsBulkRestrict

Required scope: contacts:write.Idempotency-Key required

Request body

actionenumRequired
SUPPRESS_MARKETINGWITHDRAW_MARKETING
confirmedtrueRequired
contactSidsstring (CT… SID)[]Required
reasonstring (max 256 chars)Required
requestKeystring (uuid)Required

POST /v1/accounts/{AC}/contacts/bulk-restrict

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/contacts/bulk-restrict" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "SUPPRESS_MARKETING",
  "confirmed": "string",
  "contactSids": "CT...",
  "reason": "string",
  "requestKey": "3f2b1c9e-8d4a-4b5f-9a61-0c7e2d1b4a55"
}'

Responses

List open contact identity conflicts

GET/v1/accounts/{AC}/contacts/conflicts

contacts.conflicts.listSDK operation getV1AccountsByAcContactsConflicts

An identifier that Meta or an import attached to a second contact in this account. Resolve by merging or dismissing.

Required scope: contacts:read.Paginated

Parameters

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

GET /v1/accounts/{AC}/contacts/conflicts

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

Responses

Resolve an identity conflict by merging or dismissing it

POST/v1/accounts/{AC}/contacts/conflicts/{ID}/resolve

contacts.conflicts.resolveSDK operation postV1AccountsByAcContactsConflictsByIdResolve

Required scope: contacts:write.Idempotency-Key required

Parameters

IDstring (uuid)Required

Request body

actionenumRequired
mergedismiss

POST /v1/accounts/{AC}/contacts/conflicts/{ID}/resolve

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/contacts/conflicts/ID.../resolve" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "merge"
}'

Responses

List reversible contact merge history

GET/v1/accounts/{AC}/contacts/merges

contacts.merges.listSDK operation getV1AccountsByAcContactsMerges

Required scope: contacts:read.Paginated

Parameters

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

GET /v1/accounts/{AC}/contacts/merges

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

Responses

Get contact merge recovery detail

GET/v1/accounts/{AC}/contacts/merges/{ID}

contacts.merges.retrieveSDK operation getV1AccountsByAcContactsMergesById

Required scope: contacts:read.

Parameters

IDstring (uuid)Required

GET /v1/accounts/{AC}/contacts/merges/{ID}

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

Responses

Reverse a contact merge within its 30-day window

POST/v1/accounts/{AC}/contacts/merges/{ID}/revert

contacts.merges.revertSDK operation postV1AccountsByAcContactsMergesByIdRevert

Required scope: contacts:write.Idempotency-Key required

Parameters

IDstring (uuid)Required

POST /v1/accounts/{AC}/contacts/merges/{ID}/revert

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/contacts/merges/ID.../revert" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Fetch a contact

GET/v1/accounts/{AC}/contacts/{CT}

contacts.retrieveSDK operation getV1AccountsByAcContactsByCt

Fetch one contact with its identifiers, attributes and consent summary.

Required scope: contacts:read.

Parameters

CTstring (CT… SID)Required

GET /v1/accounts/{AC}/contacts/{CT}

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

Responses

Update a contact's profile and attributes

PATCH/v1/accounts/{AC}/contacts/{CT}

contacts.updateSDK operation patchV1AccountsByAcContactsByCt

Update a contact's name, locale, time zone or attributes. Send expectedUpdatedAt to refuse the change if someone else edited the contact first.

Required scope: contacts:write.Idempotency-Key required

Parameters

CTstring (CT… SID)Required

Request body

attributesobject
displayNamenull | string (max 128 chars)
expectedUpdatedAtstring (date-time)
localenull | string (max 16 chars)
timezonenull | string (max 64 chars)

PATCH /v1/accounts/{AC}/contacts/{CT}

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

Responses

Full consent history

GET/v1/accounts/{AC}/contacts/{CT}/consents

contacts.consents.listSDK operation getV1AccountsByAcContactsByCtConsents

Required scope: contacts:read.Paginated

Parameters

CTstring (CT… SID)Required
limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/contacts/{CT}/consents

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

Responses

Record a consent event

POST/v1/accounts/{AC}/contacts/{CT}/consents

contacts.consents.createSDK operation postV1AccountsByAcContactsByCtConsents

Record that a contact opted in or out for a purpose. Consent history is append-only: a new record supersedes, never overwrites.

Required scope: contacts:write.Idempotency-Key required

Parameters

CTstring (CT… SID)Required

Request body

purposeenumRequired
TRANSACTIONALAUTHENTICATIONMARKETINGSUPPORT
sourceenumRequired
APIIMPORTKEYWORDFORMPROVIDERDASHBOARD
statusenumRequired
OPTED_INOPTED_OUTUNKNOWNREVOKEDEXPIRED
evidenceobject
Show 11 child attributes
- applicationstring (max 128 chars)
- campaignRefstring (max 128 chars)
- capturedAtstring (date-time)
- proofRefstring (max 512 chars)
- reOptInboolean
- reasonstring (max 1000 chars)
- sourcePagestring (max 2048 chars)
- supersedesConsentSidstring (CV… SID)
- withdrawnAtstring (date-time)
- wordingstring (max 4096 chars)
- wordingVersionstring (max 128 chars)
evidenceRefstring (max 512 chars)
expiresAtstring (date-time)

POST /v1/accounts/{AC}/contacts/{CT}/consents

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/contacts/CT.../consents" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "purpose": "TRANSACTIONAL",
  "source": "API",
  "status": "OPTED_IN"
}'

Responses

Merge another contact into this one

POST/v1/accounts/{AC}/contacts/{CT}/merge

contacts.mergeSDK operation postV1AccountsByAcContactsByCtMerge

The named contact becomes MERGED with merged_into set; identifiers, consents, suppressions, conversation windows (max of both) and pending dispatch move to the surviving contact. Reversible for 30 days.

Required scope: contacts:write.Idempotency-Key required

Parameters

CTstring (CT… SID)Required

Request body

mergeContactSidstring (CT… SID)Required
reasonstring (max 256 chars)Required

POST /v1/accounts/{AC}/contacts/{CT}/merge

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/contacts/CT.../merge" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "mergeContactSid": "CT...",
  "reason": "string"
}'

Responses

Resolve a separate corrected recipient without copying identity history or consent

POST/v1/accounts/{AC}/contacts/{CT}/recipient-corrections

contacts.recipientCorrectionsSDK operation postV1AccountsByAcContactsByCtRecipientCorrections

Required scope: contacts:write.Idempotency-Key required

Parameters

CTstring (CT… SID)Required

Request body

identifierobjectRequired
Show 3 child attributes
- typeenumRequired
  phone_e164bsuidusername
- valuestring (max 256 chars)Required
- scopeRefstring (max 64 chars)
reasonstring (max 256 chars)Required
separateRecipientAcknowledgedtrueRequired
defaultCountrystring (pattern ^[A-Za-z]{2}$)

POST /v1/accounts/{AC}/contacts/{CT}/recipient-corrections

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/contacts/CT.../recipient-corrections" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "identifier": {
    "type": "phone_e164",
    "value": "string"
  },
  "reason": "string",
  "separateRecipientAcknowledged": "string"
}'

Responses

List suppression history for a contact

GET/v1/accounts/{AC}/contacts/{CT}/suppressions

contacts.suppressions.listSDK operation getV1AccountsByAcContactsByCtSuppressions

Required scope: contacts:read.Paginated

Parameters

CTstring (CT… SID)Required
limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/contacts/{CT}/suppressions

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

Responses

Add a suppression

POST/v1/accounts/{AC}/contacts/{CT}/suppressions

contacts.suppressions.createSDK operation postV1AccountsByAcContactsByCtSuppressions

Stop messages to a contact, for marketing only or for everything. Suppressed contacts are refused at send time.

Required scope: contacts:write.Idempotency-Key required

Parameters

CTstring (CT… SID)Required

Request body

reasonenumRequired
CUSTOMER_OPT_OUTPROVIDER_MARKETING_OPT_OUTKEYWORD_OPT_OUTCOMPLAINTLEGAL_SUPPRESSIONTENANT_BLOCKLISTRISK_BLOCK
scopeenumRequired
MARKETINGALL
sourcestring (max 64 chars)Required
expiresAtstring (date-time)
mirrorToProviderboolean
senderSidstring (WA… SID)

POST /v1/accounts/{AC}/contacts/{CT}/suppressions

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/contacts/CT.../suppressions" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "CUSTOMER_OPT_OUT",
  "scope": "MARKETING",
  "source": "string"
}'

Responses

Remove a suppression

DELETE/v1/accounts/{AC}/contacts/{CT}/suppressions/{SU}

contacts.suppressions.deleteSDK operation deleteV1AccountsByAcContactsByCtSuppressionsBySu

Required scope: contacts:write.

Parameters

CTstring (CT… SID)Required
SUstring (SU… SID)Required
reasonstring (max 500 chars)query

DELETE /v1/accounts/{AC}/contacts/{CT}/suppressions/{SU}

curl -X DELETE "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/contacts/CT.../suppressions/SU..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

List audience segments

GET/v1/accounts/{AC}/segments

segments.listSDK operation getV1AccountsByAcSegments

Required scope: contacts:read.Paginated

Parameters

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

GET /v1/accounts/{AC}/segments

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

Responses

Create and materialize an audience segment

POST/v1/accounts/{AC}/segments

segments.createSDK operation postV1AccountsByAcSegments

Required scope: contacts:write.Idempotency-Key required

Request body

kind"DYNAMIC"Required
namestring (max 128 chars)Required
contactSidsstring (CT… SID)[]
filtersobject
Show 7 child attributes
- attributesobject
- consentobject
- createdAfterstring (date-time)
- displayNameContainsstring (max 128 chars)
- localeInstring (max 35 chars)[]
- suppressedboolean
- timezoneInstring (max 128 chars)[]

POST /v1/accounts/{AC}/segments

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

Responses

Preview typed segment membership without mutation

POST/v1/accounts/{AC}/segments/preview

segments.previewSDK operation postV1AccountsByAcSegmentsPreview

Required scope: contacts:write.Idempotency-Key required

Request body

kind"DYNAMIC"Required
contactSidsstring (CT… SID)[]
filtersobject
Show 7 child attributes
- attributesobject
- consentobject
- createdAfterstring (date-time)
- displayNameContainsstring (max 128 chars)
- localeInstring (max 35 chars)[]
- suppressedboolean
- timezoneInstring (max 128 chars)[]

POST /v1/accounts/{AC}/segments/preview

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/segments/preview" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "DYNAMIC"
}'

Responses

Get a contact segment

GET/v1/accounts/{AC}/segments/{SG}

segments.retrieveSDK operation getV1AccountsByAcSegmentsBySg

Required scope: contacts:read.

Parameters

SGstring (SG… SID)Required

GET /v1/accounts/{AC}/segments/{SG}

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

Responses

Update and rematerialize a segment

PATCH/v1/accounts/{AC}/segments/{SG}

segments.updateSDK operation patchV1AccountsByAcSegmentsBySg

Required scope: contacts:write.Idempotency-Key required

Parameters

SGstring (SG… SID)Required

Request body

kind"DYNAMIC"Required
contactSidsstring (CT… SID)[]
filtersobject
Show 7 child attributes
- attributesobject
- consentobject
- createdAfterstring (date-time)
- displayNameContainsstring (max 128 chars)
- localeInstring (max 35 chars)[]
- suppressedboolean
- timezoneInstring (max 128 chars)[]
namestring (max 128 chars)

PATCH /v1/accounts/{AC}/segments/{SG}

curl -X PATCH "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/segments/SG..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "DYNAMIC"
}'

Responses

Delete an unused segment

DELETE/v1/accounts/{AC}/segments/{SG}

segments.deleteSDK operation deleteV1AccountsByAcSegmentsBySg

Required scope: contacts:write.

Parameters

SGstring (SG… SID)Required

DELETE /v1/accounts/{AC}/segments/{SG}

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

Responses

List materialized segment members and provenance

GET/v1/accounts/{AC}/segments/{SG}/members

segments.members.listSDK operation getV1AccountsByAcSegmentsBySgMembers

Required scope: contacts:read.Paginated

Parameters

SGstring (SG… SID)Required
limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/segments/{SG}/members

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

Responses

Refresh dynamic segment membership

POST/v1/accounts/{AC}/segments/{SG}/refresh

segments.refreshSDK operation postV1AccountsByAcSegmentsBySgRefresh

Required scope: contacts:write.Idempotency-Key required

Parameters

SGstring (SG… SID)Required

POST /v1/accounts/{AC}/segments/{SG}/refresh

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

Responses

Get the durable service-window state for a sender/contact pair

GET/v1/accounts/{AC}/senders/{WA}/contacts/{CT}/window

senders.contacts.window.listSDK operation getV1AccountsByAcSendersByWaContactsByCtWindow

Required scope: senders:read.

Parameters

WAstring (WA… SID)Required
CTstring (CT… SID)Required

GET /v1/accounts/{AC}/senders/{WA}/contacts/{CT}/window

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/senders/WA.../contacts/CT.../window" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

List account suppressions with filters

GET/v1/accounts/{AC}/suppressions

suppressions.listSDK operation getV1AccountsByAcSuppressions

Account-wide by default; filter by contact, identifier, reason or scope. active=false returns the full history including lifted and expired rows.

Required scope: contacts:read.Paginated

Parameters

contactSidstring (CT… SID)query
identifierstring (max 256 chars)query
identifierTypeenumquery
phone_e164bsuidusername
scopeRefstring (max 64 chars)query
reasonstring (max 64 chars)query
scopeenumquery
MARKETINGALL
activebooleanquery
limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/suppressions

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

Responses

Suppress a contact by SID or by identifier

POST/v1/accounts/{AC}/suppressions

suppressions.createSDK operation postV1AccountsByAcSuppressions

Addressed with exactly one of contactSid or identifier. An identifier that this account has never seen resolves-or-creates the contact, so a suppression captured before the first message still holds when that message is attempted.

Required scope: contacts:write.Idempotency-Key required

Request body

reasonenumRequired
CUSTOMER_OPT_OUTPROVIDER_MARKETING_OPT_OUTKEYWORD_OPT_OUTCOMPLAINTLEGAL_SUPPRESSIONTENANT_BLOCKLISTRISK_BLOCK
scopeenumRequired
MARKETINGALL
contactSidstring (CT… SID)
expiresAtstring (date-time)
identifierstring (max 256 chars)
identifierTypeenum
phone_e164bsuidusername
mirrorToProviderboolean
scopeRefstring (max 64 chars)
senderSidstring (WA… SID)
sourcestring (max 64 chars)

POST /v1/accounts/{AC}/suppressions

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/suppressions" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "CUSTOMER_OPT_OUT",
  "scope": "MARKETING"
}'

Responses

Lift suppressions for a contact addressed by SID or identifier

DELETE/v1/accounts/{AC}/suppressions

suppressions.deleteSDK operation deleteV1AccountsByAcSuppressions

Removal is a state change, never a delete of history: each affected row keeps its record and emits suppression.removed. Narrow with suppressionSid or scope.

Required scope: contacts:write.

Request body

contactSidstring (CT… SID)
identifierstring (max 256 chars)
identifierTypeenum
phone_e164bsuidusername
reasonstring (max 500 chars)
scopeenum
MARKETINGALL
scopeRefstring (max 64 chars)
suppressionSidstring (SU… SID)

DELETE /v1/accounts/{AC}/suppressions

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

Responses