Register push token

Register a push token for the given auth token.

POST /notifications/push/v1/tokens

Register push token

cURL

curl --request POST \
  --url https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/tokens \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "providerId": "fcm-provider-2",
  "fcmToken": "<string>",
  "authToken": "cometchat-uid-3_1710141033938cf7e3c67cc44465440d",
  "timezone": "Asia/Kolkata"
}
'

200

{
  "data": {
    "success": true
  }
}

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Body

application/json

PlatformFCM

PlatformAPNS

PlatformVOIP

Response data

platform · enum<string>

FCM push token platform.

Available options: fcm_android, fcm_ios, fcm_web, fcm_flutter_android, fcm_flutter_ios, fcm_react_native_android, fcm_react_native_ios, fcm_ionic_cordova_android, fcm_ionic_cordova_ios

providerId · string

Example:

"fcm-provider-2"

fcmToken · string

authToken · string

Example:

"cometchat-uid-3_1710141033938cf7e3c67cc44465440d"

timezone · string

Example:

"Asia/Kolkata"

Response

200 - application/json

A list of push notification's settings

data · any[]

meta · object