Docs
Conversations

Add an internal note to a conversation

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

POST/api/v1/conversations/{id}/messages

Notes are never shown to the visitor and are not sent to the AI. The role is always note — this endpoint cannot post a reply on the agent’s behalf.

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 POST \
  https://www.hey.support/api/v1/conversations/<id>/messages \
  -H 'Authorization: Bearer hs_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"content":"<content>"}'

Update a conversation (tags, resolved state)

Updates the operator-owned fields of a conversation.

Create a lead

Records a lead against a chatbot, optionally linked to a conversation, and emits the `lead.created` webhook.

On this page

Path parameters
Request body
Response 200
Errors
Example