Create a contact

curl --request POST \
  --url https://api.hilos.io/api/contact \
  --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"
}

Contacts

Create or Update a contact

When you POST a new Contact, we’ll first check if another contact exists with the same phone. If it does, we’ll do a partial update to the existing contact with this new information. We do this so you don’t end up with duplicate contacts in your account.

You can set arbitrary attributes for a contact in the meta object, using meta={custom_property_1: 'some value', another_property: 'another value ...', ...}. We parse all these attributes as strings for now.

We append the received meta, tags and default_assignees properties with the contact current ones, if you want to delete some key inside the meta or a tags you have to use the overwrite_meta or overwrite_tags attributes in the request body.

POST

api

contact

Create a contact

curl --request POST \
  --url https://api.hilos.io/api/contact \
  --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"

Body

phone

string

Maximum string length: 30

first_name

string | null

Maximum string length: 100

last_name

string | null

Maximum string length: 100

string<email> | null

Maximum string length: 254

Response

201 - 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

string

required

UUID representing the contact ID

last_updated_on

string<date-time>

required

source

string

required

Maximum string length: 255

Getting started

API Reference

Create or Update a contact

Authorizations

Body

Response