Notifications

Get email notification preferences

Returns the event types the authenticated account currently receives by email, alongside the full catalog of event types that may be enabled.

get/notifications/email/preferences

Request

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

Response

OK

$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.