Skip to main content
PATCH
/
api
/
contact
/
{id}
Partially Update Contact
curl --request PATCH \
  --url https://api.hilos.io/api/contact/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "meta": {},
  "external_url": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source": "website",
  "created_on": "2023-11-07T05:31:56Z",
  "tags": [
    {
      "name": "<string>"
    }
  ],
  "default_assignees": [
    123
  ],
  "overwrite_tags": false,
  "overwrite_default_assignees": false,
  "overwrite_meta": false
}
'
{
  "canonical_phone": "<string>",
  "created_by": 123,
  "phone": "<string>",
  "id": "<string>",
  "last_updated_on": "2023-11-07T05:31:56Z",
  "source": "<string>",
  "tags": [
    {
      "id": 123,
      "name": "<string>"
    }
  ],
  "default_assignees": [
    {
      "id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "jsmith@example.com",
      "account": 123,
      "profile_image": "<string>",
      "date_joined": "2023-11-07T05:31:56Z"
    }
  ],
  "inbox_contacts": [
    {
      "url": "<string>",
      "channel": 123,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "default_conversation_url": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "meta": {},
  "external_url": "<string>",
  "created_on": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
id
string<uuid>
required

Body

​
phone
string
Maximum string length: 30
​
first_name
string | null
Maximum string length: 100
​
last_name
string | null
Maximum string length: 100
​
email
string<email> | null
Maximum string length: 254
​
meta
object
​
external_url
string<uri> | null
Maximum string length: 200
​
id
string<uuid>
​
source
string
default:website
​
created_on
string<date-time>
​
tags
object[]
​
default_assignees
integer[]
​
overwrite_tags
boolean
default:false

If true, the tags will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false.

​
overwrite_default_assignees
boolean
default:false

If true, the default_assignees will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false.

​
overwrite_meta
boolean
default:false

If true, the meta field will be overwritten with the new value. If false, the new value will be merged with the existing value. Default is false.

Response

200 - application/json
​
canonical_phone
string
required
Maximum string length: 30
​
created_by
integer
required

User ID of the user who created the contact

​
phone
string
required

Phone number of the contact

​
id
string
required

UUID representing the contact ID

​
last_updated_on
string<date-time>
required
​
source
string
required
Maximum string length: 255
​
tags
object[]
required

Tags associated with the contact

​
default_assignees
object[]
required

ID of the default assignees for the contact

​
inbox_contacts
object[]
required

URL of the inbox conversation associated with the contact

​
default_conversation_url
string
required
​
first_name
string | null
Maximum string length: 100
​
last_name
string | null
Maximum string length: 100
​
email
string<email> | null
Maximum string length: 254
​
meta
object
​
external_url
string<uri> | null
Maximum string length: 200
​
created_on
string<date-time>