logo
InboxUpdate conversation
Inbox

Update conversation

Update a conversation's read status, AI tag, or custom tags. Set markRead: true to mark all unread lead replies as read. Set aiTag to a string to apply a tag, or null to remove it.

curl -X PATCH "https://api.sendkit.ai/v1/inbox/example_string" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "markRead": true
}'
{
  "success": true,
  "data": {
    "id": "664a1b2c3d4e5f6a7b8c9d0e",
    "aiTag": "interested",
    "tags": [
      "vip"
    ]
  }
}
PATCH
/v1/inbox/{id}
PATCH
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
Bearer Token
Bearer Tokenstring
Required

API key as Bearer token

API key as Bearer token
Content-Typestring
Required

The media type of the request body

Options: application/json
markReadboolean

Set to true to mark all unread lead replies as read

aiTagstring

AI tag to apply (or null to remove)

tagsarray

Custom tags to set on the conversation

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

header
Authorizationstring
Required

Bearer token. API key as Bearer token

Path Parameters

idstring
Required

Resource ID

Body

application/json
markReadboolean

Set to true to mark all unread lead replies as read

aiTagstring

AI tag to apply (or null to remove)

tagsarray

Custom tags to set on the conversation

Responses

successboolean
dataobject