Docs
Conversations

Update a conversation (tags, resolved state)

Updates the operator-owned fields of a conversation.

PATCH/api/v1/conversations/{id}

Tags REPLACE the existing array rather than merging, so send the full list you want. Does not emit a webhook — automation-driven edits deliberately do not echo back out.

Path parameters

Prop

Type

Request body

Prop

Type

Response 200

Prop

Type

Errors

  • 400 — Invalid request body
  • 401 — Missing or invalid API key
  • 404 — Not found
  • 429 — Rate limit exceeded

Every error shares one envelope.

Example

curl -X PATCH \
  https://www.hey.support/api/v1/conversations/<id> \
  -H 'Authorization: Bearer hs_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"tags":[],"is_resolved":true}'

Get a conversation with its messages

Returns one conversation and its full message transcript, including visitor messages, AI replies, human agent replies, and internal notes.

Add an internal note to a conversation

Inserts a `note` message visible only in the operator dashboard.

On this page

Path parameters
Request body
Response 200
Errors
Example