Agents

Update an agent credential

Update the OAuth 2.0 credential for an agent in your organization.

patch/api/v2/agents/{agent_id}/inbound-credentials/{client_id}

Request

Path parameters

agent_idstring required

Agent object ID (24-character hexadecimal string).

client_idstring required

Inbound OAuth credential's client ID.

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Request body

tokenEndpointAuthMethod'client_secret_basic' | 'client_secret_post' required

OAuth token endpoint client authentication method.

Response

Credential updated successfully

clientIdstring required

OAuth client ID for this credential.

authType'client_credentials' | 'client_jwt_assertion' required

Client authentication method.

tokenEndpointAuthMethod'client_secret_basic' | 'client_secret_post' required

OAuth token endpoint client authentication method for this credential. Legacy rows with a NULL stored value are returned as client_secret_basic.

status'active' | 'retiring' | 'expired' required

Credential lifecycle status.

createdAtstring date-time required
updatedAtstring date-time required
expiresAtstring date-time nullable required

ISO 8601 date-time (UTC) or JSON null.

Changes

No recorded changes to this operation across all 1 revision of this API.