Notifications

Set email notification preferences

Replaces the set of event types the authenticated account receives by email. Every requested type must be in the available catalog, or the request is rejected with 400. An empty list disables all email notifications. Returns the updated preferences.

put/notifications/email/preferences

Request

Base URL
https://api.textla.com/v1
Auth
HTTP bearer

Request body

$schemastring uri

A URL to the JSON Schema for this object.

cadence'immediate' | 'hourly' | 'daily' | 'weekly'

Digest cadence for the emailed notifications: immediate | hourly | daily | weekly. Omit (or send immediate) for per-event delivery; a non-immediate cadence only batches digest-eligible event types, others still deliver immediately.

event_typesstring[]

Event types to email to the account owner; must all be in the available catalog. Required: send an empty array to disable all email notifications; omitting the field or sending null is rejected with 400.

send_atstring

Local send time ("HH:MM", in the account's timezone) for a daily or weekly digest. Allowed only on the daily/weekly cadence; defaults to 08:00 when omitted.

Example request

{
  "$schema": "/v1/schemas/SetPreferencesInputBody.json",
  "cadence": "daily",
  "event_types": [
    "campaign.sent"
  ],
  "send_at": "08:00"
}

Response

$schemastring uri

A URL to the JSON Schema for this object.

available_event_typesstring[] nullable required

The full catalog of event types that may be enabled.

enabled_event_typesstring[] nullable required

Event types currently emailed to the account owner.

Example response

{
  "$schema": "/v1/schemas/Preferences.json",
  "available_event_types": [
    "campaign.sent",
    "campaign.failed",
    "team.invited",
    "team.joined",
    "credit.low"
  ],
  "enabled_event_types": [
    "campaign.sent"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.