Update Endpoint
An endpoint uniquely identifies your app within Pinpoint. In order to update your endpoint use the updateEndpoint()
method:
import { Analytics } from 'aws-amplify';
// NOTE: All fields are OPTIONALawait Analytics.updateEndpoint({ address: 'xxxxxxx', // The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number. attributes: { // Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment. hobbies: ['piano', 'hiking'] // MUST be an array, even single value }, channelType: 'APNS', // The channel type. Valid values: APNS, GCM demographic: { appVersion: 'xxxxxxx', // The version of the application associated with the endpoint. locale: 'xxxxxx', // The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value make: 'xxxxxx', // The manufacturer of the endpoint device, such as Apple or Samsung. model: 'xxxxxx', // The model name or number of the endpoint device, such as iPhone. modelVersion: 'xxxxxx', // The model version of the endpoint device. platform: 'xxxxxx', // The platform of the endpoint device, such as iOS or Android. platformVersion: 'xxxxxx', // The platform version of the endpoint device. timezone: 'xxxxxx' // The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles. }, location: { city: 'xxxxxx', // The city where the endpoint is located. country: 'xxxxxx', // The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 alpha-2 code, such as "US" for the United States. latitude: 0, // The latitude of the endpoint location, rounded to one decimal place. longitude: 0, // The longitude of the endpoint location, rounded to one decimal place. postalCode: 'xxxxxx', // The postal code or zip code of the endpoint. region: 'xxxxxx' // The region of the endpoint location. For example, in the United States, this corresponds to a state. }, metrics: { // Custom metrics that your app reports to Amazon Pinpoint. }, /** Indicates whether a user has opted out of receiving messages with one of the following values: * ALL - User has opted out of all messages. * NONE - Users has not opted out and receives all messages. */ optOut: 'ALL', // Customized userId userId: 'XXXXXXXXXXXX', // User attributes userAttributes: { interests: ['football', 'basketball', 'AWS'] // ... }}).then(() => {});
Learn more about Amazon Pinpoint and Endpoints.