Skip to main content
POST
/
v2
/
notifications
/
subscriptions
/
app-push
Register an app push subscription
curl --request POST \
  --url https://api.cal.com/v2/notifications/subscriptions/app-push \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "ExponentPushToken[xxxxxxxxxxxxxxxxxxxxxx]",
  "platform": "IOS",
  "deviceId": "device-uuid-123"
}
'
{
  "status": "success",
  "data": {
    "id": 123,
    "userId": 123,
    "type": "<string>",
    "platform": "<string>",
    "identifier": "<string>",
    "deviceId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Headers

​
Authorization
string
required

value must be Bearer <token> where <token> is api key prefixed with cal_

Body

application/json
​
token
string
required

Expo Push Token

Pattern: EXPO_PUSH_TOKEN_REGEX
Example:

"ExponentPushToken[xxxxxxxxxxxxxxxxxxxxxx]"

​
platform
enum<string>
required

Mobile platform

Available options:
IOS,
ANDROID
Example:

"IOS"

​
deviceId
string
required

Unique device identifier

Example:

"device-uuid-123"

Response

201 - application/json
​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
data
object
required