HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Update Conversation

🚧

This endpoint is in beta and subject to change.

A beta revision header (2026-04-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our versioning and deprecation policy for more information.

Close a Customer Agent conversation.

status is the only updatable attribute and only closed
is accepted (the DTO's Literal constraint enforces this
before this handler runs).

Rate limits:
Burst: 3/s
Steady: 60/m

Scopes:
agents:write

Path Params
string
required
Query Params
fields[customer-agent-conversation]
array of strings
fields[customer-agent-conversation]
Body Params

Sparse request to update a Customer Agent conversation.

Only status: closed is accepted today — the public surface exposes a single allowed transition (open → closed). Future statuses will require shared billing / event-emission plumbing currently coupled to the upstream-state-driven PUT.

data
object
required
Headers
string
required
Defaults to 2026-04-15.pre

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/vnd.api+json