Skip to content

Cancel Device Registration

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

Method

DELETE

URL

https://api.backendless.com/<application-id>/<REST-api-key>/messaging/registrations/<device-id>

where:

Argument                Description
<application-id> the ID of your application generated upon its creation. You can get the value in the Manage > App Settings section of the Backendless Console.
<REST-api-key> REST API key of your application. You can get the value from the Manage > App Settings section of the Backendless Console.
<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

curl -X DELETE \  
-v https://api.backendless.com/XXXXX-XXXXX-XXXXX/ZZZZZ-ZZZZ-ZZZZ/messaging/registration/wwwwww-device-id-wwwww