---
title: "POST /app-instance-users/{appInstanceUserArn}/endpoints"
method: POST
path: "/app-instance-users/{appInstanceUserArn}/endpoints"
---

# POST /app-instance-users/{appInstanceUserArn}/endpoints

`POST /app-instance-users/{appInstanceUserArn}/endpoints`

Registers an endpoint under an Amazon Chime <code>AppInstanceUser</code>. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

## Path parameters

- `appInstanceUserArn` string, password, required

## Request body

- object
  - `Name` string, password — The name of the <code>AppInstanceUserEndpoint</code>.
  - `Type` 'APNS' | 'APNS_SANDBOX' | 'GCM', required — <p>The type of the <code>AppInstanceUserEndpoint</code>. Supported types:</p> <ul> <li> <p> <code>APNS</code>: The mobile notification service for an Apple device.</p> </li> <li> <p> <code>APNS_SANDBOX</code>: The sandbox environment of the mobile notification service for an Apple device.</p> </li> <li> <p> <code>GCM</code>: The mobile notification service for an Android device.</p> </li> </ul> <p>Populate the <code>ResourceArn</code> value of each type as <code>PinpointAppArn</code>.</p>
  - `ResourceArn` string, required — The ARN of the resource to which the endpoint belongs.
  - `EndpointAttributes` object, required — The attributes of an <code>Endpoint</code>.
    - `DeviceToken` string, password — The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
    - `VoipDeviceToken` string, password — The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
  - `ClientRequestToken` string, required — The unique ID assigned to the request. Use different tokens to register other endpoints.
  - `AllowMessages` 'ALL' | 'NONE' — Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. <code>ALL</code> indicates the endpoint receives all messages. <code>NONE</code> indicates the endpoint receives no messages.

## Response `201`

Success

- RegisterAppInstanceUserEndpointResponse
  - `AppInstanceUserArn` string — The ARN of the <code>AppInstanceUser</code>.
  - `EndpointId` string — The unique identifier of the <code>AppInstanceUserEndpoint</code>.

## Other responses

- `480` — BadRequestException
- `481` — ConflictException
- `482` — ForbiddenException
- `483` — ResourceLimitExceededException
- `484` — ThrottledClientException
- `485` — UnauthorizedClientException
- `486` — ServiceUnavailableException
- `487` — ServiceFailureException

---

[API](https://skmtc.net/aws/apis/chime-sdk-identity.md) · [All operations](https://skmtc.net/aws/apis/chime-sdk-identity/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/chime-sdk-identity/revisions/5ac0320cd9af/schema)