Skip to main content
POST
cURL
Record withdrawal of authorization and stop future collection covered by that consent. Revocation does not edit historical assessments or serve as a data-deletion command. All IDs and cursors must belong to the authorized workspace and environment. Required scope: connections:write. Examples use synthetic IDs. Replace them with values returned by your environment.

Authorizations

Authorization
string
header
required

Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.

Headers

Idempotency-Key
string
required

Stable for one intended command and its retries, scoped to key workspace/environment and operation. Mismatched body returns 409. Full response replay 24 hours; durable receipt remains.

Minimum string length: 1

Path Parameters

id
string
required

id

Minimum string length: 1

Body

application/json
reason
string
required

Reason for RevokeConsent. Constraints, requiredness and allowed values are defined by this schema.

Minimum string length: 1

Response

Successful response.

data
object
required
meta
object
required