How can we help you?

Conversation Actions in the REST API

What You Can Do

With an API key that has the write:conversations scope you can act on a conversation over REST, and with read:conversations you can read its notes. Actions go through the same service the agent workspace uses, so agents see updates live.

Endpoints

All requests use the header Authorization: Bearer vlk_... and the base path /api/v1.

  • POST /conversations/{id}/messages with { "text": "Hello" } sends an agent message. Optional agentId sets the sender.
  • POST /conversations/{id}/resolve with optional { "topic": "Billing" } closes the conversation.
  • POST /conversations/{id}/assign with { "agentId": 123 } assigns it to an agent.
  • GET /conversations/{id}/notes returns the notes on the conversation.

Responses

A conversation that does not belong to your site returns 404. Missing or invalid input returns 400 with an error message. A key without the needed scope is refused. A request is never reported as successful unless it was applied.

Share: Email

Was this article helpful?