Apple device tokens

Use these methods to manage Apple device tokens used for accessing the Apple Push Notification service.

POST[host]/api/v2/my/devices/tokens

Add an Apple device token

DELETE[host]/api/v2/my/devices/tokens/{token}

Delete an Apple device token


Add an Apple device token

Use this method to save a token obtained from a device for accessing the Apple Push Notification service.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Body:

token string required

The token obtained from a device for accessing the Apple Push Notification service.

A user may have several Apple devices on which push notifications can be managed individually.

POST[host]/api/v2/my/devices/tokens

curl --location --request POST 'https://host.name/api/v2/my/devices/tokens' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "token": "8e335894"
}'

Response

id string

The device identifier.

token string

The Apple device token.

RESPONSE EXAMPLE
{
  "id": "36f59381-5b54-48bd-a0c7-3b908c476732",
  "token": "8e335894"
}

Delete an Apple device token

Use this method to delete a token obtained from a device for accessing the Apple Push Notification service.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

token

The token obtained from a device for accessing the Apple Push Notification service.

DELETE[host]/api/v2/my/devices/tokens/{token}

curl --location --request DELETE 'https://host.name/api/v2/my/devices/tokens/8e335894' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.