Hyperscale docs Sign in Start building

Revoke provider data consent

consent.revoke

Marks an active consent record revoked, with the time and reason.

POST /v1/consents/{consentId}/revoke

Scopes: consent:write

Input

FieldTypeDescription
productId requiredstringHyperscale product ID
consentId requiredstringHyperscale customer consent ID
reason requiredstring
idempotencyKey requiredstringNew per change; reuse only to retry it.
confirmation requiredconsent_revoke | consent.revokeThis tool's name, once the founder agrees.

Request sample

curl --request POST 'https://console.hyperscale0.ai/v1/consents/{consentId}/revoke' \
  --header "Authorization: Bearer $HYPERSCALE_API_KEY" \
  --header 'X-Hyperscale-Environment: sandbox' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "productId": "<string>",
  "reason": "<string>",
  "idempotencyKey": "<string>",
  "confirmation": "<consent_revoke | consent.revoke>"
}'

All operations