Comms API ReferencePush NotificationsDevice Registrations

Register Device for Push Notifications

This operation registers the push notifications token of the device/browser to the Registration set of a Contact with the corresponding `appName`. * If a Contact ID is not provided, a new Contact is created. * If a Contact ID is provided and the Contact exists, the device is registered to the Contact.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <account_id:auth_token>.

OR
AuthorizationBasic

Basic authentication of the form Basic <api_key:api_key_secret>.

Request

This endpoint expects an object.
appNamestringRequiredformat: "^[a-z0-9_]+$"1-64 characters

The name of the App to register the device for.

If the appName does not match the name of any existing Push Notification App, the operation will fail.

tokenstringRequired
The device token to register for push notifications.
providerenumRequired
Push notification service provider.
Allowed values:

Response headers

Locationstring or null

The location (uri) of the resource identified by Resource-Id.

Response

The request was accepted and a resource ID is available to check the result. The response body contains the resource ID and link to the resource.
resourceIdstring
The Resource ID is an identifier for the resource that was created or updated in response to the request.
resourceLocationstringformat: "uri"

The location (uri) of the resource identified by Resource-Id.

Errors