GET

/#Action=SetEndpointAttributes

http://sns.{region}.amazonaws.com/#Action=SetEndpointAttributes

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>.

Access Token Required: API Key

Query Params

EndpointArnstringrequired

EndpointArn used for SetEndpointAttributes action.

Attributesobjectrequired

A map of the endpoint attributes. Attributes in this map include the following: <ul> <li> <code>CustomUserData</code> – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. </li> <li> <code>Enabled</code> – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token. </li> <li> <code>Token</code> – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service. </li> </ul>

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://sns.{region}.amazonaws.com/#Action=SetEndpointAttributes' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}