Partially update a conversation

Partially update a Conversation

PATCH /api/inbox/conversation/{id}/update

Partially Update a Conversation

cURL

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",
  "assigned": [
    {
      "id": 123
    }
  ],
  "tags": [
    {
      "name": "<string>"
    }
  ],
  "assigned_team": 123,
  "channel": 123
}
'

import requests

url = "https://api.hilos.io/api/inbox/conversation/{id}/update"

payload = {
    "id": "<string>",
    "contact": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assigned": [{ "id": 123 }],
    "tags": [{ "name": "<string>" }],
    "assigned_team": 123,
    "channel": 123
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    contact: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    assigned: [{id: 123}],
    tags: [{name: '<string>'}],
    assigned_team: 123,
    channel: 123
  })
};

fetch('https://api.hilos.io/api/inbox/conversation/{id}/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hilos.io/api/inbox/conversation/{id}/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'contact' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'assigned' => [
        [
                'id' => 123
        ]
    ],
    'tags' => [
        [
                'name' => '<string>'
        ]
    ],
    'assigned_team' => 123,
    'channel' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hilos.io/api/inbox/conversation/{id}/update"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"contact\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"assigned\": [\n    {\n      \"id\": 123\n    }\n  ],\n  \"tags\": [\n    {\n      \"name\": \"<string>\"\n    }\n  ],\n  \"assigned_team\": 123,\n  \"channel\": 123\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hilos.io/api/inbox/conversation/{id}/update")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"contact\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"assigned\": [\n    {\n      \"id\": 123\n    }\n  ],\n  \"tags\": [\n    {\n      \"name\": \"<string>\"\n    }\n  ],\n  \"assigned_team\": 123,\n  \"channel\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hilos.io/api/inbox/conversation/{id}/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"contact\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"assigned\": [\n    {\n      \"id\": 123\n    }\n  ],\n  \"tags\": [\n    {\n      \"name\": \"<string>\"\n    }\n  ],\n  \"assigned_team\": 123,\n  \"channel\": 123\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "contact": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assigned": [
    {
      "id": 123
    }
  ],
  "created_on": "2023-11-07T05:31:56Z",
  "tags": [
    {
      "id": 123,
      "name": "<string>"
    }
  ],
  "assigned_team": 123,
  "channel": 123
}

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Path Parameters

id · string<uuid> · required

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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.

Show child attributes

tags · object[]

The Tags assigned to the Conversation.

Show child attributes

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.

Show child attributes

created_on · string<date-time> · required · read-only

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.

Show child attributes

assigned_team · integer

The ID of the Team assigned to the Conversation.

channel · integer | null