Remove a registered device

POST https://your-org.veloxatalk.com/api/v1/remove_client_device

Mobile devices use this endpoint to remove their device record registered using POST /register_client_device when the user logs out.

This endpoint is currently not useful for clients other than mobile.

Changes: New in Veloxa Talk 12.0 (feature level 470).

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Veloxa Talk users and bots.

curl -sSX POST https://your-org.veloxatalk.com/api/v1/remove_client_device \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode device_id=2

Parameters

device_id integer required

Example: 2

The ID of the device to remove.


Response

Example response(s)

Changes: As of Veloxa Talk 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}