User
A user is an individual who has a unique user ID. This ID can be associated with zero or more endpoints. For example, if a person uses your app on more than one device, you can associate that person's user ID with the endpoint for each of those devices.
You can use the User resource to retrieve information about all the endpoints that are associated with a user ID, or to delete all the endpoints that are associated with a user ID.
URI
/v1/apps/
application-id
/users/user-id
HTTP methods
GET
Operation ID: GetUserEndpoints
Retrieves information about all the endpoints that are associated with a specific user ID.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
application-id | String | True | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user-id | String | True | The unique identifier for the user. The identifier can't contain |
Header parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
accept | String | False | Indicates which content types, expressed as MIME types, the client understands. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | EndpointsResponse | The request succeeded. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | MessageBody | The request contains a syntax error (BadRequestException). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | MessageBody | The request was denied because access to the specified resource is forbidden (ForbiddenException). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | MessageBody | The request failed because the specified resource was not found (NotFoundException). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
405 | MessageBody | The request failed because the method is not allowed for the specified resource (MethodNotAllowedException). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
413 | MessageBody | The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | MessageBody | The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | MessageBody | The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException). |
DELETE
Operation ID: DeleteUserEndpoints
Deletes all the endpoints that are associated with a specific user ID.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
application-id | String | True | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user-id | String | True | The unique identifier for the user. The identifier can't contain |
Header parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
accept | String | False | Indicates which content types, expressed as MIME types, the client understands. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
202 | EndpointsResponse | The request was accepted for processing. Processing may not be complete. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | MessageBody | The request contains a syntax error (BadRequestException). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | MessageBody | The request was denied because access to the specified resource is forbidden (ForbiddenException). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | MessageBody | The request failed because the specified resource was not found (NotFoundException). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
405 | MessageBody | The request failed because the method is not allowed for the specified resource (MethodNotAllowedException). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
413 | MessageBody | The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | MessageBody | The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | MessageBody | The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException). |
OPTIONS
Retrieves information about the communication requirements and options that are available for the User resource.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
application-id | String | True | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user-id | String | True | The unique identifier for the user. The identifier can't contain |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | None | The request succeeded. |
Schemas
Response bodies
{ "Item": [ { "ChannelType": enum, "Address": "string", "EndpointStatus": "string", "OptOut": "string", "RequestId": "string", "Location": { "Latitude": number, "Longitude": number, "PostalCode": "string", "City": "string", "Region": "string", "Country": "string" }, "Demographic": { "Make": "string", "Model": "string", "ModelVersion": "string", "Timezone": "string", "Locale": "string", "AppVersion": "string", "Platform": "string", "PlatformVersion": "string" }, "EffectiveDate": "string", "Attributes": { }, "Metrics": { }, "User": { "UserId": "string", "UserAttributes": { } }, "ApplicationId": "string", "Id": "string", "CohortId": "string", "CreationDate": "string" } ] }
Properties
EndpointDemographic
Specifies demographic information about an endpoint, such as the applicable time zone and platform.
Property | Type | Required | Description |
---|---|---|---|
AppVersion | string | False | The version of the app that's associated with the endpoint. Can contain a maximum of 50 characters. |
Locale | string | False | An identifier that represents the endpoint's language, in IETF BCP 47 format.
This identifier typically consists of an ISO 639-1 alpha-2 code, followed by an
underscore (_), followed by an ISO 3166-1 alpha-2 value. For example, the locale
code for United States English is In some cases, an ISO 3166-1 numeric-3 value is used instead of an ISO 3166-1
alpha-2 value. For example, the locale code for Latin American Spanish is
In other cases, the ISO 639-1 alpha-2 is replaced with a three-letter code.
For example, the locale code for Hawaiian is |
Make | string | False | The manufacturer of the endpoint device, such as |
Model | string | False | The model name or number of the endpoint device, such as |
ModelVersion | string | False | The model version of the endpoint device. Can contain a maximum of 50 characters. |
Platform | string | False | The platform of the endpoint device, such as |
PlatformVersion | string | False | The version of the platform for the endpoint device. Can contain a maximum of 50 characters. |
Timezone | string | False | The time zone of the endpoint, specified as a tz database name value, such as
|
EndpointLocation
Specifies geographic information about an endpoint.
Property | Type | Required | Description |
---|---|---|---|
City | string | False | The name of the city where the endpoint is located. Can contain a maximum of 75 characters. |
Country | string | False | A code that represents the country or region where the endpoint is located.
Must be in ISO 3166-1 Alpha-2 or Alpha-3 format. For example, for the United
States, you can use |
Latitude | number | False | The latitude coordinate of the endpoint location, rounded to one decimal place. Must be between -90 and 90. If you specify a latitude, you must also specify a longitude. |
Longitude | number | False | The longitude coordinate of the endpoint location, rounded to one decimal place. Must be between -180 and 180. If you specify a longitude, you must also specify a latitude. |
PostalCode | string | False | The postal or ZIP code for the area where the endpoint is located. |
Region | string | False | The name of the region where the endpoint is located. This value is typically a first-level subdivision a country, such as a state, province, prefecture, administrative region, district, or department. Can contain a maximum of 75 characters. |
EndpointResponse
Provides information about the channel type and other settings for an endpoint.
Property | Type | Required | Description |
---|---|---|---|
Address | string | False | The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address. |
ApplicationId | string | False | The unique identifier for the application that's associated with the endpoint. |
Attributes | object | False | 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
|
ChannelType | string Values: | False | The channel that's used when sending messages or push notifications to the endpoint. |
CohortId | string | False | A number from 0–99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns. |
CreationDate | string | False | The date and time, in ISO 8601 format, when the endpoint was created. |
Demographic | False | The demographic information for the endpoint, such as the time zone and platform. | |
EffectiveDate | string | False | The date and time, in ISO 8601 format, when the endpoint was last updated. |
EndpointStatus | string | False | Specifies whether messages or push notifications are sent to the endpoint.
Possible values are: Amazon Pinpoint automatically sets this value to |
Id | string | False | The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application. |
Location | False | The geographic information for the endpoint. | |
Metrics | object | False | One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint. |
OptOut | string | False | Specifies whether the user who's associated with the endpoint has opted out of
receiving messages and push notifications from you. Possible values are:
|
RequestId | string | False | The unique identifier for the most recent request to update the endpoint. |
User | False | One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint. |
EndpointUser
Specifies data for one or more attributes that describe the user who's associated with an endpoint.
Property | Type | Required | Description |
---|---|---|---|
UserAttributes | object | False | One or more custom attributes that describe the user by associating a name
with an array of values. For example, the value of an attribute named
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values. |
UserId | string | False | The unique identifier for the user. The identifier can't contain |
EndpointsResponse
Provides information about all the endpoints that are associated with a user ID.
Property | Type | Required | Description |
---|---|---|---|
Item | Array of type EndpointResponse | True | An array of responses, one for each endpoint that's associated with the user ID. |
MessageBody
Provides information about an API request or response.
Property | Type | Required | Description |
---|---|---|---|
Message | string | False | The message that's returned from the API. |
RequestID | string | False | The unique identifier for the request or response. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: