Cancel Device Registration¶

To cancel the registration of a device with Backendless, an application can use the API described below:

Method¶

DELETE

Endpoint URL¶

The xxxx.backendless.app is a subdomain assigned to your application. For more information see the Client-side Setup section of this documentation.

https://xxxx.backendless.app/api/messaging/registrations/<device-id>

where:

Argument	Description
`<device-id>`	ID of the device to cancel the device registration information for. Must be the same ID used in the Device Registration call.

Request Headers¶

Content-Type: application/json  
user-token: optional value obtained as a result of the login operation.

where:

Argument Description

Content-Type Must be set to application/json. This header is mandatory.

user-token Optional header. Contains a value returned by Backendless in a preceding user Login API call. If user-token is set in the request, the currently logged in user will be assigned to the ownerId property of the user object which is being saved. Additionally, the operation will be executed with the security policy associated currently logged in user. This means all permissions associated with the user and the roles assigned to the user will be enforced by Backendless.

Request Body:¶

None

Response Body¶

{  
  "result" : "true" | "false",  
}

Errors¶

When the server-side reports an error, it returns a JSON object in the following format:

{  
  "message":error-message,  
  "code":error-code  
}

The following errors may occur during the device registration cancellation API call

Error Code	Description
5001	Unable to cancel device registration - unknown device ID.

Example¶

Important

Make sure to replace xxxx in the domain name in the sample request below to the one assigned to your application.

curl -X DELETE \  
-v https://xxxx.backendless.app/api/messaging/registration/wwwwww-device-id-wwwww

Codeless Reference¶

push_cancel_device_registration_1

Returns the integer value identifying the number of channels which the device is still registered with in Backendless. This information is helpful to determine if the device should also be unregistered from FCM. When the number of remaining registrations in Backendless is zero, in some cases it might be needed to unregister from FCM as well.

The example below cancels the registration of a device with Backendless:

push_cancel_device_registration_2