Skip to navigation
Connect API

Update conversation state

View as Markdown

Changes the state of a conversation owned by the authenticated channel. The optional by field attributes the change to a user or external actor.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

conversationstringRequired

Request

This endpoint expects an object.
stateenumRequired
Allowed values:
reasonstring or nullOptional<=500 characters
byinteger or string or map from strings to anyOptional

Numeric Zorvia user ID or an object containing id or identifier.

Response

Conversation state changed successfully