Relay docs
API ReferenceConversations

Update a conversation

Updates mutable conversation parameters. Only the provided fields are changed. Requires the `conversations:write` scope.

PATCH
/v1/public/conversations/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

Workspace API key, e.g. rl_live_….

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status?string

Value in

  • "open"
  • "pending"
  • "resolved"
priority?|

Value in

  • "low"
  • "medium"
  • "high"
  • "urgent"
  • null
assignee?|

User id of a workspace member to assign, or null to unassign.

labels?array<string>
customAttributes?

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/public/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "9b2c1f7e-3d4a-4c1b-8e2f-1a2b3c4d5e6f",  "status": "open",  "priority": "high",  "labels": [    "vip",    "billing"  ],  "unreadCount": 2,  "contact": {    "id": "c0ffee00-1111-2222-3333-444455556666",    "name": "Ada Lovelace",    "email": "[email protected]",    "phoneNumber": null,    "shopName": "acme.myshopify.com"  },  "inbox": {    "id": "1b0a7d22-aaaa-bbbb-cccc-ddddeeeeffff",    "name": "Web widget",    "channelType": "web_widget"  },  "assignee": {    "id": "user_2x9Q",    "name": "Grace Hopper",    "image": "https://cdn.relay.app/u/grace.png"  },  "lastActivityAt": "2026-06-25T10:12:00.000Z",  "createdAt": "2026-06-24T08:00:00.000Z"}
{  "error": "string"}
{  "error": "string"}
{  "error": "string"}
{  "error": "string"}

List conversations GET

Returns conversations for the workspace, most recently active first. Requires the `conversations:read` scope.

Add a message to a conversation POST

Appends a message to a conversation. The message is delivered live to connected dashboard agents through the same realtime fan-out as the rest of the product. Requires the `conversations:write` scope.