PUT

/v1/apps/{application-id}/attributes/{attribute-type}

http://pinpoint.{region}.amazonaws.com/v1/apps/{application-id}/attributes/{attribute-type}

Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.

Access Token Required: API Key

Path Parameters

application-idstringrequired

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

attribute-typestringrequired

The type of attribute or attributes to remove. Valid values are: <ul><li>endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.</li> <li>endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.</li> <li>endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.</li></ul>

Body Params

UpdateAttributesRequestobjectrequired

Specifies one or more attributes to remove from all the endpoints that are associated with an application.

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 PUT \
2     --url 'http://pinpoint.{region}.amazonaws.com/v1/apps/{application-id}/attributes/{attribute-type}' \
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}