Skip to content

Revoke a grant to an AI client: your own, or any one as the workspace's owner. Its tokens stop at once, and the changes it asked for that wait are declined

DELETE
/v1/buyer/ai-clients/{id}
curl --request DELETE \
--url https://example.com/v1/buyer/ai-clients/example \
--header 'Authorization: Bearer <token>'

Who: a workspace’s buyer or viewer. Not for API keys.

id
required
string

OK

Media typeapplication/json
object
client
required
object
host
required
string
id
required
string
name
required
string
redirect_host
required
string
created_at
required
string format: date-time
effective_scopes
required
Array<string>
end_reason
required
string | null
Allowed values: revoked client_revoked membership_removed workspace_ended refresh_reused expired
ended_at
required
string | null format: date-time
ended_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
expires_at
required
string format: date-time
id
required
string
last_used_at
required
string | null format: date-time
scopes
required
Array<string>
user_id
required
string
user_name
string

Example

{
"end_reason": "revoked",
"ended_by": {
"kind": "user"
}
}

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
"error": {
"code": "example",
"fields": {
"additionalProperty": "example"
},
"message": "example"
}
}