Builder

class Builder

Properties

Link copied to clipboard

The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

Link copied to clipboard

One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

Link copied to clipboard

The channel to use when sending messages or push notifications to the endpoint.

Link copied to clipboard

The demographic information for the endpoint, such as the time zone and platform.

Link copied to clipboard

The date and time, in ISO 8601 format, when the endpoint was created or updated.

Link copied to clipboard

Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Link copied to clipboard
var id: String?

The unique identifier for the endpoint in the context of the batch.

Link copied to clipboard

The geographic information for the endpoint.

Link copied to clipboard

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

Link copied to clipboard

Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

Link copied to clipboard

The unique identifier for the request to create or update the endpoint.

Link copied to clipboard

One or more custom attributes that describe the user who's associated with the endpoint.

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard