Notifications

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

GETList effective notification-category preferencesnotificationPreferences.list
PUTSet one notification-category preferencenotificationPreferences.update
PUTSet the signed-in user's language for the console and e-mailsnotificationPreferences.language.update
GETList notificationsnotifications.list
POSTMark a notification readnotifications.read
GETDescribe a notification e-mail unsubscribe link (public)notificationUnsubscribe.retrieve
POSTTurn off one category of notification e-mail (public, RFC 8058 one-click)notificationUnsubscribe.update

List effective notification-category preferences

GET/v1/accounts/{AC}/notification-preferences

notificationPreferences.listSDK operation getV1AccountsByAcNotificationPreferences

Required scope: notifications:read.

GET /v1/accounts/{AC}/notification-preferences

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

Responses

Set one notification-category preference

PUT/v1/accounts/{AC}/notification-preferences

notificationPreferences.updateSDK operation putV1AccountsByAcNotificationPreferences

Required scope: notifications:write.Idempotency-Key required

Request body

categoryenumRequired
sender_healthtemplate_statusaction_requiredoperation_completesecurityincidentproduct_updatebillingconversation
emailbooleanRequired
inAppbooleanRequired

PUT /v1/accounts/{AC}/notification-preferences

curl -X PUT "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/notification-preferences" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "category": "sender_health",
  "email": true,
  "inApp": true
}'

Responses

Set the signed-in user's language for the console and e-mails

PUT/v1/accounts/{AC}/notification-preferences/language

notificationPreferences.language.updateSDK operation putV1AccountsByAcNotificationPreferencesLanguage

Required scope: notifications:read.Idempotency-Key required

Request body

locale"en" | "fr" | nullRequired

PUT /v1/accounts/{AC}/notification-preferences/language

curl -X PUT "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/notification-preferences/language" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "locale": "string"
}'

Responses

List notifications

GET/v1/accounts/{AC}/notifications

notifications.listSDK operation getV1AccountsByAcNotifications

Required scope: notifications:read.Paginated

Parameters

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

GET /v1/accounts/{AC}/notifications

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

Responses

Mark a notification read

POST/v1/accounts/{AC}/notifications/{notificationId}/read

notifications.readSDK operation postV1AccountsByAcNotificationsByNotificationidRead

Required scope: notifications:read.Idempotency-Key required

Parameters

notificationIdstring (uuid)Required

POST /v1/accounts/{AC}/notifications/{notificationId}/read

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

Responses

Describe a notification e-mail unsubscribe link (public)

GET/v1/notification-unsubscribe/{token}

notificationUnsubscribe.retrieveSDK operation getV1NotificationUnsubscribeByToken

No key needed

Parameters

tokenstring (pattern ^[A-Za-z0-9_-]{32,64}$)Required

GET /v1/notification-unsubscribe/{token}

curl "https://api.staging.toutye.com/v1/notification-unsubscribe/token..." \
  -H "Toutye-Version: 2026-08-21"

Responses

Turn off one category of notification e-mail (public, RFC 8058 one-click)

POST/v1/notification-unsubscribe/{token}

notificationUnsubscribe.updateSDK operation postV1NotificationUnsubscribeByToken

Idempotency-Key requiredNo key needed

Parameters

tokenstring (pattern ^[A-Za-z0-9_-]{32,64}$)Required

POST /v1/notification-unsubscribe/{token}

curl -X POST "https://api.staging.toutye.com/v1/notification-unsubscribe/token..." \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses