Skip to main content
DELETE
/
users
/
{userId}
/
consent
curl --request DELETE \
  --url https://api.example.com/users/{userId}/consent \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "deviceIds": [
    "device_abc123",
    "device_xyz789"
  ]
}
'
{
  "success": true,
  "userId": "user_abc123",
  "revokedDeviceCount": 2,
  "revokedDeviceIds": [
    "device_abc123",
    "device_xyz789"
  ]
}
Coming Soon

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
userId
string
required

The unique identifier for the user

Example:

"user_abc123"

Body

application/json

Optional array of device IDs to revoke consent for specific devices

​
deviceIds
string[]

Optional array of device IDs to revoke consent for. If omitted, revokes consent for all devices belonging to the user.

Example:
["device_abc123", "device_xyz789"]

Response

Consent revoked successfully

​
success
boolean
required
Example:

true

​
userId
string
required
Example:

"user_abc123"

​
revokedDeviceCount
number
required

Number of devices for which consent was revoked

Example:

2

​
revokedDeviceIds
string[]
required

Array of device IDs for which consent was revoked

Example:
["device_abc123", "device_xyz789"]