Skip to main content
PATCH
/
api
/
inbox
/
conversation
/
{id}
/
update
Partially Update a Conversation
curl --request PATCH \
  --url https://api.hilos.io/api/inbox/conversation/{id}/update \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "contact": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "CREATED",
  "assigned": [
    {
      "id": 123
    }
  ],
  "tags": [
    {
      "name": "<string>"
    }
  ],
  "assigned_team": 123,
  "channel": 123
}'
{
  "id": "<string>",
  "contact": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "CREATED",
  "assigned": [
    {
      "id": 123
    }
  ],
  "tags": [
    {
      "id": 123,
      "name": "<string>"
    }
  ],
  "created_on": "2023-11-07T05:31:56Z",
  "source": "INBOX",
  "assigned_team": 123,
  "channel": 123
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
id
string<uuid>
required

Body

​
id
string

The UUID of the Conversation.

​
contact
string<uuid>
​
status
enum<string>
Available options:
CREATED,
FLOW,
FLOW_PAUSED,
NEW,
IN_PROGRESS,
RESOLVED,
CLOSED
​
assigned
object[]

The Users assigned to the Conversation.

​
tags
object[]

The Tags assigned to the Conversation.

​
assigned_team
integer

The ID of the Team assigned to the Conversation.

​
channel
integer | null

Response

200 - application/json
​
id
string
required

The UUID of the Conversation.

​
contact
string<uuid>
required
​
assigned
object[]
required

The Users assigned to the Conversation.

​
created_on
string<date-time>
required
​
source
enum<string>
required
Available options:
INBOX,
AUTO_RESPONSE,
API,
BROADCAST,
FLOW,
UNKNOWN
​
status
enum<string>
Available options:
CREATED,
FLOW,
FLOW_PAUSED,
NEW,
IN_PROGRESS,
RESOLVED,
CLOSED
​
tags
object[]

The Tags assigned to the Conversation.

​
assigned_team
integer

The ID of the Team assigned to the Conversation.

​
channel
integer | null