Get the conversation-attribute schema

GET 
/conversation-attributes

The account's conversation-attribute schema: the custom fields a conversation can carry.

api_id is the key you use when writing values at PATCH /v1/conversations/{id}/custom-attributes, and type decides what a value may be — the write endpoint enforces it.

Read-only on purpose. This is a schema, and reshaping it from a machine credential would silently invalidate values on conversations that already carry them.

Scope: conversation_attributes

Responses

200

The schema.

Response Headers

X-Request-Id

Correlation id for this request. Quote it when reporting a problem.

401

No token, an expired token, or a credential that has been revoked.

Response Headers

X-Request-Id

Correlation id for this request. Quote it when reporting a problem.

403

Refused. Either the credential does not hold the scope this endpoint needs (code: insufficient_scope), or the account's IP allow-list does not include the calling address (code: ip_not_allowed).

Response Headers

X-Request-Id

Correlation id for this request. Quote it when reporting a problem.