Skip to main content

SubscriberSummary

Contact and presence information returned in a subscriber listing.

Usage profiles​

UsageFields and validation
In responsesView fields

In responses​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
subscriberIdstringOptionalIdentifier of the notification subscriber.
emailstringOptionalEmail address used for subscriber contact and delivery.
firstNamestringOptionalSubscriber’s given name.
lastNamestringOptionalSubscriber’s family name.
isOnlinebooleanOptionalWhether the provider reports the subscriber currently online.
lastOnlineAtstring (date-time)OptionalTime when the provider last observed the subscriber online.

Where used​

ReferenceRelationship
List all subscribersPOST /api/v1/notifications/manage/list-subscribers

Download the public reference contract.

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