Skip to main content
POST
Pause or retire a buyer agent

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

principalId
string
required
Pattern: ^prin_[A-Za-z0-9_-]{32}$

Body

application/json
kind
enum<string>
required
Available options:
suspend
expectedLifecycleState
enum<string>
required
Available options:
active
confirmationText
string
required

Exact buyer-agent display name typed by the administrator.

Required string length: 1 - 255

Response

Pause or retire a buyer agent

data
object
required
error
enum<string> | null
required
Available options:
null