> ## Documentation Index
> Fetch the complete documentation index at: https://readme.amana-dev.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Register device for push

> Register a device token so the user receives push notifications.

## Body

Content type: `application/json`

<ParamField body="token" type="string" required />

<ParamField body="platform" type="enum<string>" required>
  Available options: `ios`, `android`, `web`, `windows`, `macos`
</ParamField>

<ParamField body="appsflyer_id" type="string" />

<ParamField body="firebase_app_instance_id" type="string" />

<ParamField body="braze_user_id" type="string" />

<ParamField body="amplitude_device_id" type="string" />

## Response

`200` Success.

<ResponseField name="success" type="boolean" />

## Possible Errors

| Error | Possible cause | What to do |
| - | - | - |
| 400 | Invalid or missing field | Check the request against the schema. |
| 403 | IP not whitelisted, or account restricted | Confirm your IP is whitelisted; otherwise contact Amana. |
| 429 / 5xx | Rate limit, or temporary issue on our side | Retry with backoff; contact support if it persists. |

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url 'https://gateway.amana.io/user/notifications/token' \
    --header 'Content-Type: application/json' \
    --data '{
    "token": "<string>",
    "platform": "ios",
    "appsflyer_id": "<string>",
    "firebase_app_instance_id": "<string>",
    "braze_user_id": "<string>",
    "amplitude_device_id": "<string>"
  }'
  ```

  ```python Python theme={null}
  import requests

  url = "https://gateway.amana.io/user/notifications/token"
  headers = {"Content-Type": "application/json"}
  payload = {
      "token": "<string>",
      "platform": "ios",
      "appsflyer_id": "<string>",
      "firebase_app_instance_id": "<string>",
      "braze_user_id": "<string>",
      "amplitude_device_id": "<string>"
  }

  response = requests.request("POST", url, json=payload, headers=headers)
  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://gateway.amana.io/user/notifications/token', {
    method: 'POST',
    headers: {"Content-Type": "application/json"},
    body: JSON.stringify({"token": "<string>", "platform": "ios", "appsflyer_id": "<string>", "firebase_app_instance_id": "<string>", "braze_user_id": "<string>", "amplitude_device_id": "<string>"}),
  });
  console.log(await response.json());
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true
  }
  ```

  ```json 400 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 403 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 429 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 500 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.