Users

Revoke user consent

Revoke consent for a user. The affected devices stop receiving pulls and pushes. When a revoked link is the last one on a device, and the manufacturer supports it, Amps first hands the device back to its owner at the manufacturer, and revokes the access token there once no other link uses it; if either step fails, the request fails and the links are kept. Pass a deviceIds array to scope the revocation; omit it to revoke every device under the user.

DELETE

users

{userId}

consent

curl

curl --request DELETE \
  --url 'https://api.amps.ai/users/user_abc123/consent' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx' \
  --header 'content-type: application/json' \
  --data '{}'

const response = await fetch('https://api.amps.ai/users/user_abc123/consent', {
  method: 'DELETE',
  headers: {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
    'content-type': 'application/json',
  },
  body: JSON.stringify({}),
});

const data = await response.json();

import requests

url = 'https://api.amps.ai/users/user_abc123/consent'
headers = {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
    'content-type': 'application/json',
}
payload = {}

response = requests.delete(url, headers=headers, json=payload)
data = response.json()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.amps.ai/users/{userId}/consent",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.amps.ai/users/{userId}/consent"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("DELETE", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.amps.ai/users/{userId}/consent")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.amps.ai/users/{userId}/consent")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "success": true,
    "userId": "user_abc123",
    "revokedDeviceCount": 2,
    "revokedDeviceIds": [
      "device_abc123",
      "device_xyz789"
    ]
  },
  "meta": {
    "requestId": "req_8a2Bf3kP",
    "environment": "sandbox",
    "timestamp": "2026-06-02T12:00:00.000Z",
    "latencyMs": 12
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

userId

string

required

The unique identifier for the user.

Example:

"user_abc123"

Body

application/json

deviceIds

string[]

Response

Consent revoked successfully.

success

boolean

required

Always true for success responses.

data

Revoke Consent · object

required

Show child attributes

meta

Response Meta · object

required

Metadata attached to every response: the request identifier, the serving environment, the build timestamp, and the server-side latency.

Show child attributes

curl

curl --request DELETE \
  --url 'https://api.amps.ai/users/user_abc123/consent' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx' \
  --header 'content-type: application/json' \
  --data '{}'

const response = await fetch('https://api.amps.ai/users/user_abc123/consent', {
  method: 'DELETE',
  headers: {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
    'content-type': 'application/json',
  },
  body: JSON.stringify({}),
});

const data = await response.json();

import requests

url = 'https://api.amps.ai/users/user_abc123/consent'
headers = {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
    'content-type': 'application/json',
}
payload = {}

response = requests.delete(url, headers=headers, json=payload)
data = response.json()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.amps.ai/users/{userId}/consent",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.amps.ai/users/{userId}/consent"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("DELETE", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.amps.ai/users/{userId}/consent")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.amps.ai/users/{userId}/consent")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "success": true,
    "userId": "user_abc123",
    "revokedDeviceCount": 2,
    "revokedDeviceIds": [
      "device_abc123",
      "device_xyz789"
    ]
  },
  "meta": {
    "requestId": "req_8a2Bf3kP",
    "environment": "sandbox",
    "timestamp": "2026-06-02T12:00:00.000Z",
    "latencyMs": 12
  }
}

Get started

API Reference

Guides

Cookbooks

Revoke user consent

Authorizations

Path Parameters

Body

Response