PUT

/v1/apps/{application-id}/endpoints/{endpoint-id}

http://pinpoint.{region}.amazonaws.com/v1/apps/{application-id}/endpoints/{endpoint-id}

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

Access Token Required: API Key

Path Parameters

application-idstringrequired

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

endpoint-idstringrequired

The unique identifier for the endpoint.

Body Params

EndpointRequestobjectrequired

Specifies the channel type and other settings for an endpoint.

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}/endpoints/{endpoint-id}' \
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}