Opt-in links

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

GETList hosted opt-in form linksoptInLinks.list
POSTCreate a hosted opt-in form linkoptInLinks.create
POSTRevoke a hosted opt-in form linkoptInLinks.revoke
GETRead a hosted opt-in form (public)optIn.retrieve
POSTSubmit a hosted opt-in form (public)optIn.update

List hosted opt-in form links

GET/v1/accounts/{AC}/opt-in-links

optInLinks.listSDK operation getV1AccountsByAcOptInLinks

Required scope: contacts:read.

GET /v1/accounts/{AC}/opt-in-links

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

Responses

Create a hosted opt-in form link

POST/v1/accounts/{AC}/opt-in-links

optInLinks.createSDK operation postV1AccountsByAcOptInLinks

Mints a link to a form Toutye hosts. A person who submits it and confirms by sending the one-time code from that WhatsApp number becomes a contact with an OPTED_IN consent for the purpose, citing this link and its exact wording as evidence. The token is returned once and stored hashed.

Required scope: contacts:write.Idempotency-Key required

Request body

consentTextstring (max 1000 chars)Required
labelstring (max 120 chars)Required
defaultCountrystring (pattern ^[A-Za-z]{2}$)
Two-letter country a number typed without + is read against. Defaults to the organization's country.
expiresInDaysinteger (1–3650)
publicBusinessNamestring (max 120 chars)
Public business name fixed for this form link. Omit only to retain the explicitly labelled legacy account name.
purposeenum
MARKETINGTRANSACTIONALSUPPORT

POST /v1/accounts/{AC}/opt-in-links

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

Responses

Revoke a hosted opt-in form link

POST/v1/accounts/{AC}/opt-in-links/{OL}/revoke

optInLinks.revokeSDK operation postV1AccountsByAcOptInLinksByOlRevoke

The form stops accepting submissions. The row stays, because the consents it collected cite it.

Required scope: contacts:write.Idempotency-Key required

Parameters

OLstring (OL… SID)Required

POST /v1/accounts/{AC}/opt-in-links/{OL}/revoke

curl -X POST "https://api.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/opt-in-links/OL.../revoke" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Read a hosted opt-in form (public)

GET/v1/opt-in/{token}

optIn.retrieveSDK operation getV1OptInByToken

No key needed

Parameters

tokenstring (max 256 chars)Required

GET /v1/opt-in/{token}

curl "https://api.toutye.com/v1/opt-in/token..." \
  -H "Toutye-Version: 2026-08-21"

Responses

Submit a hosted opt-in form (public)

POST/v1/opt-in/{token}

optIn.updateSDK operation postV1OptInByToken

Starts a confirmation: answers 202 with a one-time code and a WhatsApp click-to-chat link. The OPTED_IN consent (source FORM, citing the link and its exact wording) is recorded only when that code arrives on WhatsApp from the submitted number.

Idempotency-Key requiredNo key needed

Parameters

tokenstring (max 256 chars)Required

Request body

agreedbooleanRequired
phonestring (max 32 chars)Required
namestring (max 200 chars)

POST /v1/opt-in/{token}

curl -X POST "https://api.toutye.com/v1/opt-in/token..." \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "agreed": true,
  "phone": "string"
}'

Responses