Skip to main content

SubscriberData

Contact, locale, and custom attributes used by notification delivery.

Usage profiles​

UsageFields and validation
In requestsView fields
In responsesView fields

In requests​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
firstNamestringOptionalSubscriber’s given name.
lastNamestringOptionalSubscriber’s family name.
emailstringOptionalEmail address used for subscriber contact and delivery.
phonestringOptionalPhone number used for subscriber contact and delivery.
avatarUrlstringOptionalURL of the subscriber’s avatar image.
localestringOptionalSubscriber locale used when rendering notifications.
timezonestringOptionalSubscriber time zone used for notification presentation.
customDataMap from string to stringOptionalAdditional template variables.

In responses​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
firstNamestringOptionalSubscriber’s given name.
lastNamestringOptionalSubscriber’s family name.
emailstringOptionalEmail address used for subscriber contact and delivery.
phonestringOptionalPhone number used for subscriber contact and delivery.
avatarUrlstringOptionalURL of the subscriber’s avatar image.
localestringOptionalSubscriber locale used when rendering notifications.
timezonestringOptionalSubscriber time zone used for notification presentation.
customDataMap from string to stringOptionalAdditional template variables.

Where used​

ReferenceRelationship
Update subscriber profile dataPOST /api/v1/notifications/manage/update-subscriber-data
Get the caller's subscriber profilePOST /api/v1/notifications/manage/get-subscriber

Download the public reference contract.

Document: DOC-API-MODEL-subscriber-data.