POST
/
v1
/
notification
register a device to get push notification
curl --request POST \
  --url https://apix.us.amity.co/v1/notification \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "deviceId": "<string>",
  "platform": "android",
  "token": "<string>",
  "userId": "<string>",
  "provider": "<string>"
}'
{
  "status": "<string>",
  "data": {}
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Information required to register a device for push notifications

​
deviceId
string
required

Unique identifier for the device

Maximum length: 150
​
platform
enum<string>
required

Operating system platform of the device

Available options:
android,
ios
​
token
string
required

Device token for push notification. For iOS, token must be ≤ 400 characters and in hexadecimal format

Maximum length: 1000
​
userId
string
required

Identifier of the user associated with this device

​
provider
string

Push notification service provider

Response

Success response.

​
status
string
​
data
object