Skip to main content

Hilos API (1.0.0)

Download OpenAPI specification:Download

All of the below API endpoints require API key authentication, get your token at https://app.hilos.io/dev/api-keys.

To use this token, send with every request an Authorization: Token <your token> header.

Production API server is located at api.hilos.io using HTTPS.

No versioning info is required for now.

User

List Users

Lists Users.

Authorizations:
tokenAuth
query Parameters
email__icontains
string
email__iendswith
string
email__iexact
string
email__isnull
boolean
email__istartswith
string
first_name__icontains
string
first_name__iendswith
string
first_name__iexact
string
first_name__isnull
boolean
first_name__istartswith
string
last_name__icontains
string
last_name__iendswith
string
last_name__iexact
string
last_name__isnull
boolean
last_name__istartswith
string
ordering
string

Which field to use when ordering the results.

search
string
Examples:
  • search=erik@hilos.io - created by email

You can search users with the email, first_name or last_name fields.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

WhatsApp

List WhatsApp Templates

Lists WhatsApp Templates. You can search with the name and status fields using the ?seach=my-template-name query parameter.

Authorizations:
tokenAuth
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string

A search term.

Responses

Response samples

Content type
application/json
{}

Get WhatsApp Template

Gets a WhatsApp Template by Id.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "language": "af",
  • "components": {
    },
  • "id": "string",
  • "category": "ACCOUNT_UPDATE",
  • "status": "approved",
  • "rejected_reason": "string",
  • "is_deleted": true
}

Delete WhatsApp Template

Deletes a WhatsApp Template by Id.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>

Responses

Send a WhatsApp Template Message

Send a single WhatsApp message: select a template to use and call our endpoint with the recipient phone number and the variables the template needs. That's it!

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Examples:
  • a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - The Template Id that we want to send

Template Id

Request Body schema:
variables
Array of strings
phone
required
string

Responses

Request samples

Content type
{
  • "variables": [
    ],
  • "phone": "string"
}

Response samples

Content type
application/json

Returns the Message Id and its Conversation Id.

{
  • "id": "a513da3a-8b73-42aa-a938-0eb1e0141533",
  • "conversation": "ee49ab6c-dfd8-4cb6-a512-5880f4385622"
}

Broadcast

List Broadcasts

Lists Broadcasts

Authorizations:
tokenAuth
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string
Examples:
  • search=July%20promotion%20v1 - name is
  • search=Pending - with `PENDING` status
  • search=En%20curso - with `RUNNING` status
  • search=Completado - with `COMPLETED` status
  • search=Cancelado - with `CANCELED` status

You can search by name, status fields.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

Create Broadcasts

Create Broadcasts

Authorizations:
tokenAuth
Request Body schema:
name
required
string <= 100 characters
start_on
string <date-time>
required
Array of objects (MessageBlastPublicRecipient)
whatsapp_template
string or null <uuid>
Array of objects (ContactTag)
has_priority
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "start_on": "2019-08-24T14:15:22Z",
  • "recipients": [
    ],
  • "whatsapp_template": "38467788-fad7-4066-94e7-1e1c2d5db219",
  • "contact_tags": [
    ],
  • "has_priority": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "created_by": "string",
  • "is_active": true,
  • "start_on": "2019-08-24T14:15:22Z",
  • "status": "PENDING",
  • "recipients": [
    ],
  • "template_body": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "sent": 0,
  • "delivered": 0,
  • "read": 0,
  • "answered": 0,
  • "failed": 0,
  • "pending": 0,
  • "whatsapp_template": {
    },
  • "contact_tags": [
    ],
  • "has_priority": true
}

Get Broadcast Detail

Get Broadcast Detail

Authorizations:
tokenAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "created_by": "string",
  • "is_active": true,
  • "start_on": "2019-08-24T14:15:22Z",
  • "status": "PENDING",
  • "recipients": [
    ],
  • "template_body": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "sent": 0,
  • "delivered": 0,
  • "read": 0,
  • "answered": 0,
  • "failed": 0,
  • "pending": 0,
  • "whatsapp_template": {
    },
  • "contact_tags": [
    ],
  • "has_priority": true
}

Flow Execution

List Flow Execution

Lists Flow Executions.

Authorizations:
tokenAuth
query Parameters
flow
string <uuid>
Examples:
  • flow=a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Only return the Flow Executions of this Flow

A Flow Id to filter the Flow Executions and only get those from that Flow.

page
integer

A page number within the paginated result set.

search
string
Examples:
  • search=erik@hilos.io - created by email
  • search=Ready - with `READY` status
  • search=Running - with `RUNNING` status
  • search=Completed - with `COMPLETED` status
  • search=Canceled - with `CANCELED` status
  • search=Paused - with `PAUSED` status

You can search with the status, created_by__email fields.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

Get Flow Execution

Get Flow Execution by Id.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Examples:
  • a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Query by Id

A Flow Execution Id to retrive.

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "execute_for": "FILTERS",
  • "execution_type": "INBOUND",
  • "created_by": {
    },
  • "inbound_start_message": "string",
  • "inbound_start_message_match_exact": true,
  • "contact_filters": [
    ],
  • "contact_lists": [
    ],
  • "contact_executions": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "flow": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "pending": 2147483647,
  • "expired": 2147483647,
  • "active": 2147483647,
  • "completed": 2147483647,
  • "inbound_trigger_with": "ANY_MESSAGE",
  • "has_priority": true,
  • "flow_execution_variables": {
    }
}

Update Flow Execution

Update a Flow Execution.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Examples:
  • a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Update Flow Execution with Id

The Flow Execution Id to Update.

Request Body schema:
execute_for
required
string (ExecuteForEnum)
Enum: "FILTERS" "LIST" "ALL"
inbound_trigger_with
string (InboundTriggerWithEnum)
Enum: "ANY_MESSAGE" "TEXT" "IMAGE" "FILE"
inbound_start_message
string or null
inbound_start_message_match_exact
boolean
Array of objects (FlowExecutionContactFilterEdit)
Array of objects (FlowExecutionContactListEdit)
id
string <uuid>
has_priority
boolean
object
start_on
string or null <date-time>

Responses

Request samples

Content type
{
  • "execute_for": "FILTERS",
  • "inbound_trigger_with": "ANY_MESSAGE",
  • "inbound_start_message": "string",
  • "inbound_start_message_match_exact": true,
  • "contact_filters": [
    ],
  • "contact_lists": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "has_priority": true,
  • "flow_execution_variables": {
    },
  • "start_on": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "execute_for": "FILTERS",
  • "inbound_trigger_with": "ANY_MESSAGE",
  • "inbound_start_message": "string",
  • "inbound_start_message_match_exact": true,
  • "contact_filters": [
    ],
  • "contact_lists": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "has_priority": true,
  • "flow_execution_variables": {
    },
  • "start_on": "2019-08-24T14:15:22Z"
}

Partial Update Flow Execution

Update a Flow Execution sending only the properties you want to update.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Examples:
  • a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Update Flow Execution with Id

The Flow Execution Id to Update.

Request Body schema:
execute_for
string (ExecuteForEnum)
Enum: "FILTERS" "LIST" "ALL"
inbound_trigger_with
string (InboundTriggerWithEnum)
Enum: "ANY_MESSAGE" "TEXT" "IMAGE" "FILE"
inbound_start_message
string or null
inbound_start_message_match_exact
boolean
Array of objects (FlowExecutionContactFilterEdit)
Array of objects (FlowExecutionContactListEdit)
id
string <uuid>
has_priority
boolean
object
start_on
string or null <date-time>

Responses

Request samples

Content type
{
  • "execute_for": "FILTERS",
  • "inbound_trigger_with": "ANY_MESSAGE",
  • "inbound_start_message": "string",
  • "inbound_start_message_match_exact": true,
  • "contact_filters": [
    ],
  • "contact_lists": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "has_priority": true,
  • "flow_execution_variables": {
    },
  • "start_on": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "execute_for": "FILTERS",
  • "inbound_trigger_with": "ANY_MESSAGE",
  • "inbound_start_message": "string",
  • "inbound_start_message_match_exact": true,
  • "contact_filters": [
    ],
  • "contact_lists": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "has_priority": true,
  • "flow_execution_variables": {
    },
  • "start_on": "2019-08-24T14:15:22Z"
}

Download the Flow Execution Results in a CSV file

Get Flow Execution by Id.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Examples:
  • a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Flow Execution Id

A Flow Execution Id to Download the Results.

Responses

Create a Flow Execution

Create a Flow Execution of a Flow.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Examples:
  • a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Create by Flow Id

A Flow Id to create a Flow Execution.

Request Body schema:
execute_for
required
string (ExecuteForEnum)
Enum: "FILTERS" "LIST" "ALL"
inbound_trigger_with
string (InboundTriggerWithEnum)
Enum: "ANY_MESSAGE" "TEXT" "IMAGE" "FILE"
inbound_start_message
string or null
inbound_start_message_match_exact
boolean
Array of objects (FlowExecutionContactFilterEdit)
Array of objects (FlowExecutionContactListEdit)
id
string <uuid>
has_priority
boolean
object
start_on
string or null <date-time>

Responses

Request samples

Content type
{
  • "execute_for": "FILTERS",
  • "inbound_trigger_with": "ANY_MESSAGE",
  • "inbound_start_message": "string",
  • "inbound_start_message_match_exact": true,
  • "contact_filters": [
    ],
  • "contact_lists": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "has_priority": true,
  • "flow_execution_variables": {
    },
  • "start_on": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "execute_for": "FILTERS",
  • "inbound_trigger_with": "ANY_MESSAGE",
  • "inbound_start_message": "string",
  • "inbound_start_message_match_exact": true,
  • "contact_filters": [
    ],
  • "contact_lists": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "has_priority": true,
  • "flow_execution_variables": {
    },
  • "start_on": "2019-08-24T14:15:22Z"
}

Flow Execution Contact

List Flow Execution Contact

Lists Flow Execution Contacts.

Authorizations:
tokenAuth
query Parameters
contact
string <uuid>
Examples:
  • contact=a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Only return the Flow Executions Contact of this Contact

A Contact Id to filter the Flow Execution Contacts and only get those from that Contact.

flow_execution
string <uuid>
Examples:
  • flow_execution=a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Only return the Flow Executions Contact of this Flow Execution

A Flow Execution Id to filter the Flow Execution Contacts and only get those from that Flow Execution.

flow_execution__flow
string <uuid>
Examples:
  • flow_execution__flow=a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Only return the Flow Executions Contact of this flow

A Flow Id to filter the Flow Execution Contacts and only get those from that Flow.

is_active
boolean
Examples:
  • is_active=true&is_active=any-truthy-value&is_active=1 - Only return the Flow Executions Contact that are with status `READY`, `RUNNING` or `PAUSED`.
  • is_active=false&is_active=0 - Only return the Flow Executions Contact that are with status `CANCELED` or `COMPLETED`.

A boolean param to filter between active/in progress Flow Execution Contacs.

If the parameter is omitted it will respond with Flow Execution Contacts with any status.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string
Examples:
  • search=erik@hilos.io - by contact email
  • search=+525512345678 - by contact phone
  • search=Smith - by contact last_name
  • search=Jonh - by contact first_name

You can search with the contact__phone, contact__first_name, contact__last_name, contact__email fields.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

Get Flow Execution Contact

Get Flow Execution Contact by Id.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Examples:
  • a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Query by Id

A Flow Execution Contact Id to Retrive.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contact": {
    },
  • "status": "READY",
  • "execution_steps": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "flow_execution": {
    },
  • "reason": "string"
}

Contact

List Contacts

Lists contacts.

Authorizations:
tokenAuth
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string
Examples:
  • search=erik@hilos.io - by contact email
  • search=+525512345678 - by contact phone
  • search=Smith - by contact last_name
  • search=Jonh - by contact first_name

You can search with the base phone, first_name, last_name, email and external_url fields.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

Create or Update Contact

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

You can set arbitrary attributes for a contact in the meta object, using meta={key1: value1, key2: value2, ...}. We parse all these attributes as strings for now.

We append the received meta and notes properties with the contact current ones, if you want to delete some key inside the meta or a note you have to use the PUT method sending all the contact fields.

Authorizations:
tokenAuth
Request Body schema:
phone
required
string
first_name
string or null <= 100 characters
last_name
string or null <= 100 characters
email
string or null <email> <= 254 characters
object
external_url
string or null <uri> <= 200 characters
is_deleted
boolean
id
string <uuid>
source
string
Default: "website"
created_on
string <date-time> (Creado el)
Array of objects (ContactTag)
external_id
string or null
Array of objects (AccountMemberUserBasic)
contact_import
string or null <uuid>

Responses

Request samples

Content type
{
  • "phone": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "meta": {
    },
  • "external_url": "http://example.com",
  • "is_deleted": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "source": "website",
  • "created_on": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "external_id": "string",
  • "default_assignees": [
    ],
  • "contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}

Response samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "meta": {
    },
  • "external_url": "http://example.com",
  • "canonical_phone": "string",
  • "is_deleted": true,
  • "created_by": 0,
  • "phone": "string",
  • "id": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_updated_on": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "notes": [
    ],
  • "tags": [
    ],
  • "last_conversation": "string",
  • "default_assignees": [
    ],
  • "phone_status": "UNKNOWN",
  • "contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}

Get Contact

Gets a Contact by Id.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "meta": {
    },
  • "external_url": "http://example.com",
  • "canonical_phone": "string",
  • "is_deleted": true,
  • "created_by": 0,
  • "phone": "string",
  • "id": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_updated_on": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "notes": [
    ],
  • "tags": [
    ],
  • "last_conversation": "string",
  • "default_assignees": [
    ],
  • "phone_status": "UNKNOWN",
  • "contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}

Update Contact

Update a Contact.

If you send a empty meta or notes the contact will have those properties removed.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Request Body schema:
phone
required
string
first_name
string or null <= 100 characters
last_name
string or null <= 100 characters
email
string or null <email> <= 254 characters
object
external_url
string or null <uri> <= 200 characters
is_deleted
boolean
id
string <uuid>
source
string
Default: "website"
created_on
string <date-time> (Creado el)
Array of objects (ContactTag)
external_id
string or null
Array of objects (AccountMemberUserBasic)
contact_import
string or null <uuid>

Responses

Request samples

Content type
{
  • "phone": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "meta": {
    },
  • "external_url": "http://example.com",
  • "is_deleted": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "source": "website",
  • "created_on": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "external_id": "string",
  • "default_assignees": [
    ],
  • "contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}

Response samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "meta": {
    },
  • "external_url": "http://example.com",
  • "canonical_phone": "string",
  • "is_deleted": true,
  • "created_by": 0,
  • "phone": "string",
  • "id": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_updated_on": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "notes": [
    ],
  • "tags": [
    ],
  • "last_conversation": "string",
  • "default_assignees": [
    ],
  • "phone_status": "UNKNOWN",
  • "contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}

Partial Update Contact

Update a Contact sending only the properties you want to update.

If you send the meta or notes the contact will have those properties appended with the contact current ones..

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Request Body schema:
phone
string
first_name
string or null <= 100 characters
last_name
string or null <= 100 characters
email
string or null <email> <= 254 characters
object
external_url
string or null <uri> <= 200 characters
is_deleted
boolean
id
string <uuid>
source
string
Default: "website"
created_on
string <date-time> (Creado el)
Array of objects (ContactTag)
external_id
string or null
Array of objects (AccountMemberUserBasic)
contact_import
string or null <uuid>

Responses

Request samples

Content type
{
  • "phone": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "meta": {
    },
  • "external_url": "http://example.com",
  • "is_deleted": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "source": "website",
  • "created_on": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "external_id": "string",
  • "default_assignees": [
    ],
  • "contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}

Response samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "meta": {
    },
  • "external_url": "http://example.com",
  • "canonical_phone": "string",
  • "is_deleted": true,
  • "created_by": 0,
  • "phone": "string",
  • "id": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_updated_on": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "notes": [
    ],
  • "tags": [
    ],
  • "last_conversation": "string",
  • "default_assignees": [
    ],
  • "phone_status": "UNKNOWN",
  • "contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}

Delete Contact

Deleting a contact won't delete its history nor its sent messages.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>

Responses

Upload contacts .csv

Use this endpoint to upload a .csv programmatically. If you want to use the contacts created through this .csv in a flow execution, save the returned upload_group_id. For more information, check the Create FlowExecution method.

Authorizations:
tokenAuth
Request Body schema: text/csv
string <binary>

Responses

Response samples

Content type
application/json
{
  • "upload_group_id": "4bc77648-4e61-4785-9eb4-358732dbaa4c"
}

Conversation

List Conversations

Lists Conversations.

Authorizations:
tokenAuth
query Parameters
contact
string <uuid>
Examples:
  • contact=a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Only return the Conversations of this Contact

A Contact Id to filter the Conversations and only get those from that Contact.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string

A search term.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "results": [
    ]
}

Update a Conversation

Update a Conversation

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Request Body schema:
id
required
string
contact
required
string <uuid>
status
string (ConversationStatusEnum)
Enum: "CREATED" "FLOW" "NEW" "IN_PROGRESS" "RESOLVED" "CLOSED"
required
Array of objects (AccountMemberUser)
Array of objects (ConversationTag)

Responses

Request samples

Content type
{
  • "id": "string",
  • "contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
  • "status": "CREATED",
  • "assigned": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
  • "status": "CREATED",
  • "assigned": [
    ],
  • "tags": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "source": "INBOX"
}

Partially update a Conversation

Partially update a Conversation

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Request Body schema:
id
string
contact
string <uuid>
status
string (ConversationStatusEnum)
Enum: "CREATED" "FLOW" "NEW" "IN_PROGRESS" "RESOLVED" "CLOSED"
Array of objects (AccountMemberUser)
Array of objects (ConversationTag)

Responses

Request samples

Content type
{
  • "id": "string",
  • "contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
  • "status": "CREATED",
  • "assigned": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
  • "status": "CREATED",
  • "assigned": [
    ],
  • "tags": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "source": "INBOX"
}

Webhook Subscription

List Webhook Subscriptions

Lists Webhook Subscriptions.

Authorizations:
tokenAuth
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string
Examples:
  • search=example.com - some site webhooks

You can search with the id and target fields.

Responses

Response samples

Content type
application/json
{}

Create Webhook Subscription

Creates a new Webhook Subscritption.

Authorizations:
tokenAuth
Request Body schema:
id
string <uuid>
is_active
boolean
events
required
Array of strings (EventsEnum)
Items Enum: "contact.created" "contact.updated" "contact.deleted" "flow_execution_contact.completed" "flow_execution_contact.running_inbound"
target
required
string <uri> (Target URL) <= 255 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_active": true,
  • "events": [
    ],
  • "target": "http://example.com"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_active": true,
  • "events": [
    ],
  • "target": "http://example.com"
}

Get Webhook Subscription

Gets a Webhook Subscription by Id.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Examples:
  • a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Webhook Subscription Id

The Webhook Subscription Id.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_active": true,
  • "events": [
    ],
  • "target": "http://example.com"
}

Update Webhook Subscription

Update a Webhook Subscription.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Examples:
  • a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Webhook Subscription Id

The Webhook Subscription Id.

Request Body schema:
id
string <uuid>
is_active
boolean
events
required
Array of strings (EventsEnum)
Items Enum: "contact.created" "contact.updated" "contact.deleted" "flow_execution_contact.completed" "flow_execution_contact.running_inbound"
target
required
string <uri> (Target URL) <= 255 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_active": true,
  • "events": [
    ],
  • "target": "http://example.com"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_active": true,
  • "events": [
    ],
  • "target": "http://example.com"
}

Partial Update Webhook Subscription

Update a Webhook Subscription sending only the properties you want to update.

If you send the meta or notes the contact will have those properties appended with the contact current ones..

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>
Examples:
  • a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Webhook Subscription Id

The Webhook Subscription Id.

Request Body schema:
id
string <uuid>
is_active
boolean
events
Array of strings (EventsEnum)
Items Enum: "contact.created" "contact.updated" "contact.deleted" "flow_execution_contact.completed" "flow_execution_contact.running_inbound"
target
string <uri> (Target URL) <= 255 characters

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_active": true,
  • "events": [
    ],
  • "target": "http://example.com"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_active": true,
  • "events": [
    ],
  • "target": "http://example.com"
}

Delete Webhook Subscription

Delete a Webhook Subscription to stop receiving the webhooks.

Authorizations:
tokenAuth
path Parameters
id
required
string <uuid>

Responses