Skip to navigation
API ReferenceUnenrollments

Unenroll an account from agent-executed commerce

Unenrolls an account from Agentic Commerce

Authentication

AuthorizationBearer

OAuth 2.0 client credentials. Exchange your API key and secret for a bearer token, then send it as Authorization: Bearer <token>.

Headers

AuthorizationstringRequired

The OAuth authorization header generated as prescribed in the Oauth 2.0 guide

trackingIdstringRequired
A unique identifier for request tracking.
agentIdstringRequired
Agent's unique identifier.

Request

A Request to remove an enrolled account. The request payload is JWE-encrypted on the wire.

enrollmentIdstringRequired
A unique identifier for the enrolled account.
initiatorenumRequired

Indicates the source that triggered the unenrollment action, distinguishing between user-initiated and agent-initiated requests.

Allowed values:
reasonCodeenumRequired
A predefined code representing the reason for unenrollment, used to support auditability, compliance, and operational decisioning.

Response

Successful response

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error