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

[{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"groups": [{"id": 0,
"name": "string"
}
],
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
]

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

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"name": "string",
"language": "af",
"components": {"property1": null,
"property2": null
},
"id": "string",
"category": "ACCOUNT_UPDATE",
"status": "approved",
"rejected_reason": "string",
"is_deleted": true
}
]
}

Get WhatsApp Template

Gets a WhatsApp Template by Id.

Authorizations:

tokenAuth

path Parameters

required

string <uuid>

Responses

Response samples

Content type

application/json

{"name": "string",
"language": "af",
"components": {"property1": null,
"property2": null
},
"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

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

required

string <uuid>

Examples:

a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - The Template Id that we want to send

Template Id

Request Body schema:
application/json

variables	Array of strings
phone required	string

Responses

Request samples

Payload

Content type

application/json

{"variables": ["string"
],
"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,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"name": "string",
"created_by": "string",
"is_active": true,
"start_on": "2019-08-24T14:15:22Z",
"status": "PENDING",
"recipients": [0
],
"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": {"name": "string",
"language": "af",
"components": {"property1": null,
"property2": null
},
"id": "string",
"category": "ACCOUNT_UPDATE",
"status": "approved",
"rejected_reason": "string",
"is_deleted": true
},
"contact_tags": [0
],
"has_priority": true
}
]
}

Create Broadcasts

Authorizations:

tokenAuth

Request Body schema:
application/json

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

Payload

Content type

application/json

{"name": "string",
"start_on": "2019-08-24T14:15:22Z",
"recipients": [{"phone": "string",
"data": ["string"
]
}
],
"whatsapp_template": "38467788-fad7-4066-94e7-1e1c2d5db219",
"contact_tags": [{"name": "string"
}
],
"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": [0
],
"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": {"name": "string",
"language": "af",
"components": {"property1": null,
"property2": null
},
"id": "string",
"category": "ACCOUNT_UPDATE",
"status": "approved",
"rejected_reason": "string",
"is_deleted": true
},
"contact_tags": [0
],
"has_priority": true
}

Get Broadcast Detail

Authorizations:

tokenAuth

path Parameters

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": [0
],
"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": {"name": "string",
"language": "af",
"components": {"property1": null,
"property2": null
},
"id": "string",
"category": "ACCOUNT_UPDATE",
"status": "approved",
"rejected_reason": "string",
"is_deleted": true
},
"contact_tags": [0
],
"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,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"status": "string",
"execute_for": "FILTERS",
"execution_type": "INBOUND",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
},
"inbound_start_message": "string",
"inbound_start_message_match_exact": true,
"contact_filters": [{"field": "string",
"comparison": "exact",
"value": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"contact_lists": [{"source": "LIST",
"file_contacts": [{"contact": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"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": [{"id": null,
"notes": null,
"contact": null,
"created_on": null,
"created_by": null
}
],
"tags": [{"id": null,
"name": null
}
],
"last_conversation": "string",
"default_assignees": [{"first_name": null,
"last_name": null,
"email": null,
"id": null,
"account": null,
"profile_image": null,
"date_joined": null
}
],
"phone_status": "UNKNOWN",
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}
}
],
"list_contacts": [{"contact": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"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": [{"id": null,
"notes": null,
"contact": null,
"created_on": null,
"created_by": null
}
],
"tags": [{"id": null,
"name": null
}
],
"last_conversation": "string",
"default_assignees": [{"first_name": null,
"last_name": null,
"email": null,
"id": null,
"account": null,
"profile_image": null,
"date_joined": null
}
],
"phone_status": "UNKNOWN",
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}
}
]
}
],
"contact_executions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"flow": {"name": "string",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": {"name": "string",
"contact_available_variables": ["string"
],
"default_timezone": "string",
"dialog360_settings": {"d360_channel_id": "string",
"d360_channel_name": "string",
"api_key": "string",
"api_key_ro": "string",
"webhook_token": "string",
"proxy_requests": true,
"proxy_url": "http://example.com",
"webhook_set": true
},
"meta_cloud_api_settings": {"access_token_ro": "string",
"webhook_verify_token": "string",
"app_token_ro": "string",
"proxy_requests": true,
"proxy_url": "http://example.com",
"webhook_set": true,
"whatsapp_business_account_id": "string",
"phone_number_id": "string",
"app_id": "string",
"hilos_webhook_url": "string"
},
"has_working_hours": true,
"after_hours_response": "string",
"working_hours": [{"day": 0,
"is_open": true,
"open_at": "14:15:22Z",
"close_at": "14:15:22Z"
}
],
"inbox_add_name_before_message": true,
"timer_after_hours_response": "14:15:22Z",
"measure_customer_satisfaction_per_conversation": true,
"measure_customer_satisfaction_per_conversation_data": {"body": "string",
"answer_validation_message": "string",
"answer_options_render_list_section_title": "string",
"answer_options_render_list_button_title": "string",
"answer_options": ["string"
]
},
"should_autoclose_conversations": true,
"autoclose_conversations_after": 32767,
"status": "NEW",
"sandbox_number": "string",
"generated_code": "string",
"autoclose_measure_customer_satisfaction_per_conversation": 32767,
"archive_conversations_when_closed": true,
"agents_can_see_all_conversations": true,
"feature_flags": ["string"
],
"subscription": {"status": "incomplete",
"stripe_id": "string",
"current_period_start": "2019-08-24T14:15:22Z",
"current_period_end": "2019-08-24T14:15:22Z",
"items": [{"stripe_id": "string",
"price": {"stripe_id": null,
"name": null,
"currency": null,
"is_active": null,
"id": null,
"unit_amount": null,
"billing_scheme": null,
"tiers": { },
"currency_options": { },
"product": null,
"description": null
},
"quantity": 2147483647
}
],
"last_invoice": {"stripe_invoice_url": "http://example.com",
"stripe_invoice_pdf_url": "http://example.com",
"id": 0,
"total": 2147483647,
"status": "draft",
"start_on": "2019-08-24T14:15:22Z",
"end_on": "2019-08-24T14:15:22Z",
"stripe_id": "string",
"stripe_name": "string",
"currency": "str",
"line_items": [{"stripe_id": null,
"amount": null,
"unit_amount": null,
"currency": null,
"quantity": null,
"period_start": null,
"period_end": null,
"price": null,
"description": null,
"proration": null,
"id": null
}
],
"last_payment_intent": {"stripe_id": "string",
"invoice": 0,
"amount": 2147483647,
"currency": "str",
"description": "string",
"status": "requires_payment_method",
"last_payment_error_code": "string",
"last_payment_error_decline_code": "string",
"last_payment_error_message": "string",
"last_payment_error_type": "api_error"
}
}
},
"payment_methods": [{"stripe_id": "string",
"payment_method_type": "string",
"card_brand": "string",
"card_country": "st",
"card_exp_month": "st",
"card_exp_year": "stri",
"card_funding": "credit",
"card_last4": "stri",
"created_on": "2019-08-24T14:15:22Z"
}
],
"country": "AF"
},
"groups": [{"id": 0,
"name": "string"
}
],
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z",
"notify_when_msg_comes_in_after_hours": true,
"inbox_contact_info_fields": {"property1": null,
"property2": null
}
},
"is_active": true,
"flow_end_action": "WEBHOOK",
"flow_webhook_url": "http://example.com",
"flow_webhook_retries": 32767,
"execution_type": "INBOUND",
"flow_execution_variables": ["string"
],
"steps": [{"flow": "92fe31c9-39b9-47ea-906d-cf09a4c3fa9a",
"name": "string",
"step_type": "CONDITIONAL",
"next_step_default_idx": 32767,
"id": 0,
"answer_type": "FREE_TEXT",
"body": "string",
"body_type": "audio",
"body_file_url": "http://example.com",
"body_file_type": "URL",
"body_file": "90ac6969-fe45-44c3-bf4f-6aad314f969c",
"answer_validation_message": "string",
"answer_instructions": "string",
"answer_options": ["string"
],
"answer_phone_default_country": "AF",
"next_step_alternate_idx": 32767,
"conditions": [0
],
"delay_type": "string",
"delay_until": "2019-08-24T14:15:22Z",
"action_request_method": "GET",
"action_request_url": "http://example.com",
"action_request_headers": {"property1": "string",
"property2": "string"
},
"action_request_params": {"property1": "string",
"property2": "string"
},
"action_request_body": "string",
"action_test_response_data": "670df78f-99c9-4f91-8a3b-467f7549c574",
"answer_allow_decimals": true,
"answer_range_min": "string",
"answer_range_max": "string",
"answer_has_range": true,
"assign_to_users": [0
],
"ordering_idx": 32767,
"has_options_from_variable": true,
"option_from_variable_value": "string",
"options_from_variable": "string",
"option_from_variable_title": "string",
"missing_options_message": "string",
"answer_options_render": "BUTTONS",
"answer_options_render_list_button_title": "string",
"answer_options_render_list_section_title": "string",
"next_steps_for_options_idx": [-2147483648
],
"contact_tags": ["string"
],
"conversation_tags": ["string"
],
"max_wait_time_amount": 32767,
"max_wait_time_unit": "MINUTE",
"time_windows": [0
],
"has_max_wait_time": true,
"set_time_window": true
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"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": {"property1": null,
"property2": null
}
}
]
}

Get Flow Execution

Get Flow Execution by Id.

Authorizations:

tokenAuth

path Parameters

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": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
},
"inbound_start_message": "string",
"inbound_start_message_match_exact": true,
"contact_filters": [{"field": "string",
"comparison": "exact",
"value": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"contact_lists": [{"source": "LIST",
"file_contacts": [{"contact": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"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": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
}
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"last_conversation": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"phone_status": "UNKNOWN",
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}
}
],
"list_contacts": [{"contact": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"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": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
}
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"last_conversation": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"phone_status": "UNKNOWN",
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}
}
]
}
],
"contact_executions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"flow": {"name": "string",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": {"name": "string",
"contact_available_variables": ["string"
],
"default_timezone": "string",
"dialog360_settings": {"d360_channel_id": "string",
"d360_channel_name": "string",
"api_key": "string",
"api_key_ro": "string",
"webhook_token": "string",
"proxy_requests": true,
"proxy_url": "http://example.com",
"webhook_set": true
},
"meta_cloud_api_settings": {"access_token_ro": "string",
"webhook_verify_token": "string",
"app_token_ro": "string",
"proxy_requests": true,
"proxy_url": "http://example.com",
"webhook_set": true,
"whatsapp_business_account_id": "string",
"phone_number_id": "string",
"app_id": "string",
"hilos_webhook_url": "string"
},
"has_working_hours": true,
"after_hours_response": "string",
"working_hours": [{"day": 0,
"is_open": true,
"open_at": "14:15:22Z",
"close_at": "14:15:22Z"
}
],
"inbox_add_name_before_message": true,
"timer_after_hours_response": "14:15:22Z",
"measure_customer_satisfaction_per_conversation": true,
"measure_customer_satisfaction_per_conversation_data": {"body": "string",
"answer_validation_message": "string",
"answer_options_render_list_section_title": "string",
"answer_options_render_list_button_title": "string",
"answer_options": ["string"
]
},
"should_autoclose_conversations": true,
"autoclose_conversations_after": 32767,
"status": "NEW",
"sandbox_number": "string",
"generated_code": "string",
"autoclose_measure_customer_satisfaction_per_conversation": 32767,
"archive_conversations_when_closed": true,
"agents_can_see_all_conversations": true,
"feature_flags": ["string"
],
"subscription": {"status": "incomplete",
"stripe_id": "string",
"current_period_start": "2019-08-24T14:15:22Z",
"current_period_end": "2019-08-24T14:15:22Z",
"items": [{"stripe_id": "string",
"price": {"stripe_id": "string",
"name": "string",
"currency": "str",
"is_active": true,
"id": 0,
"unit_amount": 2147483647,
"billing_scheme": "tiered",
"tiers": {"property1": null,
"property2": null
},
"currency_options": {"property1": null,
"property2": null
},
"product": {"name": "string",
"is_active": true,
"prices": [null
],
"is_addon": true,
"description": "string",
"id": 0,
"features": [null
],
"block_grouping": 32767
},
"description": "string"
},
"quantity": 2147483647
}
],
"last_invoice": {"stripe_invoice_url": "http://example.com",
"stripe_invoice_pdf_url": "http://example.com",
"id": 0,
"total": 2147483647,
"status": "draft",
"start_on": "2019-08-24T14:15:22Z",
"end_on": "2019-08-24T14:15:22Z",
"stripe_id": "string",
"stripe_name": "string",
"currency": "str",
"line_items": [{"stripe_id": "string",
"amount": 2147483647,
"unit_amount": 2147483647,
"currency": "str",
"quantity": 2147483647,
"period_start": "2019-08-24T14:15:22Z",
"period_end": "2019-08-24T14:15:22Z",
"price": {"stripe_id": "string",
"name": "string",
"currency": "str",
"is_active": true,
"id": 0,
"unit_amount": 2147483647,
"billing_scheme": "tiered",
"tiers": {"property1": null,
"property2": null
},
"currency_options": {"property1": null,
"property2": null
},
"product": {"name": null,
"is_active": null,
"prices": [ ],
"is_addon": null,
"description": null,
"id": null,
"features": [ ],
"block_grouping": null
},
"description": "string"
},
"description": "string",
"proration": true,
"id": 0
}
],
"last_payment_intent": {"stripe_id": "string",
"invoice": 0,
"amount": 2147483647,
"currency": "str",
"description": "string",
"status": "requires_payment_method",
"last_payment_error_code": "string",
"last_payment_error_decline_code": "string",
"last_payment_error_message": "string",
"last_payment_error_type": "api_error"
}
}
},
"payment_methods": [{"stripe_id": "string",
"payment_method_type": "string",
"card_brand": "string",
"card_country": "st",
"card_exp_month": "st",
"card_exp_year": "stri",
"card_funding": "credit",
"card_last4": "stri",
"created_on": "2019-08-24T14:15:22Z"
}
],
"country": "AF"
},
"groups": [{"id": 0,
"name": "string"
}
],
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z",
"notify_when_msg_comes_in_after_hours": true,
"inbox_contact_info_fields": {"property1": null,
"property2": null
}
},
"is_active": true,
"flow_end_action": "WEBHOOK",
"flow_webhook_url": "http://example.com",
"flow_webhook_retries": 32767,
"execution_type": "INBOUND",
"flow_execution_variables": ["string"
],
"steps": [{"flow": "92fe31c9-39b9-47ea-906d-cf09a4c3fa9a",
"name": "string",
"step_type": "CONDITIONAL",
"next_step_default_idx": 32767,
"id": 0,
"answer_type": "FREE_TEXT",
"body": "string",
"body_type": "audio",
"body_file_url": "http://example.com",
"body_file_type": "URL",
"body_file": "90ac6969-fe45-44c3-bf4f-6aad314f969c",
"answer_validation_message": "string",
"answer_instructions": "string",
"answer_options": ["string"
],
"answer_phone_default_country": "AF",
"next_step_alternate_idx": 32767,
"conditions": [0
],
"delay_type": "string",
"delay_until": "2019-08-24T14:15:22Z",
"action_request_method": "GET",
"action_request_url": "http://example.com",
"action_request_headers": {"property1": "string",
"property2": "string"
},
"action_request_params": {"property1": "string",
"property2": "string"
},
"action_request_body": "string",
"action_test_response_data": "670df78f-99c9-4f91-8a3b-467f7549c574",
"answer_allow_decimals": true,
"answer_range_min": "string",
"answer_range_max": "string",
"answer_has_range": true,
"assign_to_users": [0
],
"ordering_idx": 32767,
"has_options_from_variable": true,
"option_from_variable_value": "string",
"options_from_variable": "string",
"option_from_variable_title": "string",
"missing_options_message": "string",
"answer_options_render": "BUTTONS",
"answer_options_render_list_button_title": "string",
"answer_options_render_list_section_title": "string",
"next_steps_for_options_idx": [-2147483648
],
"contact_tags": ["string"
],
"conversation_tags": ["string"
],
"max_wait_time_amount": 32767,
"max_wait_time_unit": "MINUTE",
"time_windows": [0
],
"has_max_wait_time": true,
"set_time_window": true
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"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": {"property1": null,
"property2": null
}
}

Update Flow Execution

Update a Flow Execution.

Authorizations:

tokenAuth

path Parameters

required

string <uuid>

Examples:

a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Update Flow Execution with Id

The Flow Execution Id to Update.

Request Body schema:
application/json

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

Payload

Content type

application/json

{"execute_for": "FILTERS",
"inbound_trigger_with": "ANY_MESSAGE",
"inbound_start_message": "string",
"inbound_start_message_match_exact": true,
"contact_filters": [{"field": "string",
"comparison": "exact",
"value": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"contact_lists": [{"source": "LIST",
"contact_file": {"upload_group_id": "4bc77648-4e61-4785-9eb4-358732dbaa4c"
},
"contact_list": [{"phone": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"external_url": "http://example.com",
"is_deleted": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"source": "website",
"created_on": "2019-08-24T14:15:22Z",
"tags": [{"name": "string"
}
],
"external_id": "string",
"default_assignees": [{"id": 0
}
],
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}
]
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"has_priority": true,
"flow_execution_variables": {"property1": null,
"property2": null
},
"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": [{"field": "string",
"comparison": "exact",
"value": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"contact_lists": [{"source": "LIST",
"contact_file": {"upload_group_id": "4bc77648-4e61-4785-9eb4-358732dbaa4c"
},
"contact_list": [{"phone": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"external_url": "http://example.com",
"is_deleted": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"source": "website",
"notes": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
}
}
],
"created_on": "2019-08-24T14:15:22Z",
"tags": [{"id": 0,
"name": "string"
}
],
"external_id": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}
]
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"has_priority": true,
"flow_execution_variables": {"property1": null,
"property2": null
},
"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

required

string <uuid>

Examples:

a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Update Flow Execution with Id

The Flow Execution Id to Update.

Request Body schema:
application/json

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

Payload

Content type

application/json

{"execute_for": "FILTERS",
"inbound_trigger_with": "ANY_MESSAGE",
"inbound_start_message": "string",
"inbound_start_message_match_exact": true,
"contact_filters": [{"field": "string",
"comparison": "exact",
"value": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"contact_lists": [{"source": "LIST",
"contact_file": {"upload_group_id": "4bc77648-4e61-4785-9eb4-358732dbaa4c"
},
"contact_list": [{"phone": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"external_url": "http://example.com",
"is_deleted": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"source": "website",
"created_on": "2019-08-24T14:15:22Z",
"tags": [{"name": "string"
}
],
"external_id": "string",
"default_assignees": [{"id": 0
}
],
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}
]
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"has_priority": true,
"flow_execution_variables": {"property1": null,
"property2": null
},
"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": [{"field": "string",
"comparison": "exact",
"value": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"contact_lists": [{"source": "LIST",
"contact_file": {"upload_group_id": "4bc77648-4e61-4785-9eb4-358732dbaa4c"
},
"contact_list": [{"phone": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"external_url": "http://example.com",
"is_deleted": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"source": "website",
"notes": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
}
}
],
"created_on": "2019-08-24T14:15:22Z",
"tags": [{"id": 0,
"name": "string"
}
],
"external_id": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}
]
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"has_priority": true,
"flow_execution_variables": {"property1": null,
"property2": null
},
"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

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

required

string <uuid>

Examples:

a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Create by Flow Id

A Flow Id to create a Flow Execution.

Request Body schema:
application/json

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

Payload

Content type

application/json

{"execute_for": "FILTERS",
"inbound_trigger_with": "ANY_MESSAGE",
"inbound_start_message": "string",
"inbound_start_message_match_exact": true,
"contact_filters": [{"field": "string",
"comparison": "exact",
"value": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"contact_lists": [{"source": "LIST",
"contact_file": {"upload_group_id": "4bc77648-4e61-4785-9eb4-358732dbaa4c"
},
"contact_list": [{"phone": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"external_url": "http://example.com",
"is_deleted": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"source": "website",
"created_on": "2019-08-24T14:15:22Z",
"tags": [{"name": "string"
}
],
"external_id": "string",
"default_assignees": [{"id": 0
}
],
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}
]
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"has_priority": true,
"flow_execution_variables": {"property1": null,
"property2": null
},
"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": [{"field": "string",
"comparison": "exact",
"value": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"contact_lists": [{"source": "LIST",
"contact_file": {"upload_group_id": "4bc77648-4e61-4785-9eb4-358732dbaa4c"
},
"contact_list": [{"phone": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"external_url": "http://example.com",
"is_deleted": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"source": "website",
"notes": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
}
}
],
"created_on": "2019-08-24T14:15:22Z",
"tags": [{"id": 0,
"name": "string"
}
],
"external_id": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}
]
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"has_priority": true,
"flow_execution_variables": {"property1": null,
"property2": null
},
"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,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"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": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
}
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"last_conversation": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"phone_status": "UNKNOWN",
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
},
"status": "READY",
"created_on": "2019-08-24T14:15:22Z",
"reason": "string",
"flow_name": "string"
}
]
}

Get Flow Execution Contact

Get Flow Execution Contact by Id.

Authorizations:

tokenAuth

path Parameters

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": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"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": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
}
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"last_conversation": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"phone_status": "UNKNOWN",
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
},
"status": "READY",
"execution_steps": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"step": {"flow": "92fe31c9-39b9-47ea-906d-cf09a4c3fa9a",
"name": "string",
"step_type": "CONDITIONAL",
"next_step_default_idx": 32767,
"id": 0,
"answer_type": "FREE_TEXT",
"body": "string",
"body_type": "audio",
"body_file_url": "http://example.com",
"body_file_type": "URL",
"body_file": "90ac6969-fe45-44c3-bf4f-6aad314f969c",
"answer_validation_message": "string",
"answer_instructions": "string",
"answer_options": ["string"
],
"answer_phone_default_country": "AF",
"next_step_alternate_idx": 32767,
"conditions": [0
],
"delay_type": "string",
"delay_until": "2019-08-24T14:15:22Z",
"action_request_method": "GET",
"action_request_url": "http://example.com",
"action_request_headers": {"property1": "string",
"property2": "string"
},
"action_request_params": {"property1": "string",
"property2": "string"
},
"action_request_body": "string",
"action_test_response_data": "670df78f-99c9-4f91-8a3b-467f7549c574",
"answer_allow_decimals": true,
"answer_range_min": "string",
"answer_range_max": "string",
"answer_has_range": true,
"assign_to_users": [0
],
"ordering_idx": 32767,
"has_options_from_variable": true,
"option_from_variable_value": "string",
"options_from_variable": "string",
"option_from_variable_title": "string",
"missing_options_message": "string",
"answer_options_render": "BUTTONS",
"answer_options_render_list_button_title": "string",
"answer_options_render_list_section_title": "string",
"next_steps_for_options_idx": [-2147483648
],
"contact_tags": ["string"
],
"conversation_tags": ["string"
],
"max_wait_time_amount": 32767,
"max_wait_time_unit": "MINUTE",
"time_windows": [0
],
"has_max_wait_time": true,
"set_time_window": true
},
"last_error_detail": "string",
"has_error": true,
"execution_result": {"property1": null,
"property2": null
},
"request_data": {"property1": null,
"property2": null
},
"messages": [{"message": {"id": "string",
"to_number": "string",
"from_number": "string",
"body": "string",
"direction": "string",
"timestamp": "2019-08-24T14:15:22Z",
"contact": "string",
"status": "new",
"queued_on": "2019-08-24T14:15:22Z",
"accepted_on": "2019-08-24T14:15:22Z",
"sent_on": "2019-08-24T14:15:22Z",
"delivered_on": "2019-08-24T14:15:22Z",
"read_on": "2019-08-24T14:15:22Z",
"failed_on": "2019-08-24T14:15:22Z",
"provider_id": "string",
"provider_error_code": "string",
"provider_error_message": "string",
"sent_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"groups": [{"id": 0,
"name": "string"
}
],
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
},
"is_deleted": true,
"content": {"property1": null,
"property2": null
},
"whatsapp_template": {"name": "string",
"language": "af",
"components": {"property1": null,
"property2": null
},
"id": "string",
"category": "ACCOUNT_UPDATE",
"status": "approved",
"rejected_reason": "string",
"is_deleted": true
},
"content_type": "string",
"content_url": "http://example.com",
"msg_type": "audio",
"location": {"address": "string",
"latitude": 0,
"longitude": 0,
"place_name": "string",
"place_url": "http://example.com",
"map_screenshot_url": "http://example.com"
},
"failed_attempts": 0,
"contacts": [{"addresses": [{"property1": null,
"property2": null
}
],
"emails": [{"property1": null,
"property2": null
}
],
"ims": [{"property1": null,
"property2": null
}
],
"urls": ["http://example.com"
],
"name": {"property1": "string",
"property2": "string"
},
"phones": [{"property1": null,
"property2": null
}
],
"org": {"property1": "string",
"property2": "string"
}
}
],
"source": "INBOUND"
}
}
],
"created_on": "2019-08-24T14:15:22Z"
}
],
"created_on": "2019-08-24T14:15:22Z",
"flow_execution": {"status": "string",
"execute_for": "FILTERS",
"execution_type": "INBOUND",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
},
"inbound_start_message": "string",
"inbound_start_message_match_exact": true,
"contact_filters": [{"field": "string",
"comparison": "exact",
"value": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"contact_lists": [{"source": "LIST",
"file_contacts": [{"contact": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"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": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": null,
"last_name": null,
"email": null,
"id": null
}
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"last_conversation": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"phone_status": "UNKNOWN",
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}
}
],
"list_contacts": [{"contact": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"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": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": null,
"last_name": null,
"email": null,
"id": null
}
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"last_conversation": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"phone_status": "UNKNOWN",
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}
}
]
}
],
"contact_executions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"flow": {"name": "string",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": {"name": "string",
"contact_available_variables": ["string"
],
"default_timezone": "string",
"dialog360_settings": {"d360_channel_id": "string",
"d360_channel_name": "string",
"api_key": "string",
"api_key_ro": "string",
"webhook_token": "string",
"proxy_requests": true,
"proxy_url": "http://example.com",
"webhook_set": true
},
"meta_cloud_api_settings": {"access_token_ro": "string",
"webhook_verify_token": "string",
"app_token_ro": "string",
"proxy_requests": true,
"proxy_url": "http://example.com",
"webhook_set": true,
"whatsapp_business_account_id": "string",
"phone_number_id": "string",
"app_id": "string",
"hilos_webhook_url": "string"
},
"has_working_hours": true,
"after_hours_response": "string",
"working_hours": [{"day": 0,
"is_open": true,
"open_at": "14:15:22Z",
"close_at": "14:15:22Z"
}
],
"inbox_add_name_before_message": true,
"timer_after_hours_response": "14:15:22Z",
"measure_customer_satisfaction_per_conversation": true,
"measure_customer_satisfaction_per_conversation_data": {"body": "string",
"answer_validation_message": "string",
"answer_options_render_list_section_title": "string",
"answer_options_render_list_button_title": "string",
"answer_options": ["string"
]
},
"should_autoclose_conversations": true,
"autoclose_conversations_after": 32767,
"status": "NEW",
"sandbox_number": "string",
"generated_code": "string",
"autoclose_measure_customer_satisfaction_per_conversation": 32767,
"archive_conversations_when_closed": true,
"agents_can_see_all_conversations": true,
"feature_flags": ["string"
],
"subscription": {"status": "incomplete",
"stripe_id": "string",
"current_period_start": "2019-08-24T14:15:22Z",
"current_period_end": "2019-08-24T14:15:22Z",
"items": [{"stripe_id": "string",
"price": {"stripe_id": "string",
"name": "string",
"currency": "str",
"is_active": true,
"id": 0,
"unit_amount": 2147483647,
"billing_scheme": "tiered",
"tiers": {"property1": null,
"property2": null
},
"currency_options": {"property1": null,
"property2": null
},
"product": {"name": null,
"is_active": null,
"prices": [ ],
"is_addon": null,
"description": null,
"id": null,
"features": [ ],
"block_grouping": null
},
"description": "string"
},
"quantity": 2147483647
}
],
"last_invoice": {"stripe_invoice_url": "http://example.com",
"stripe_invoice_pdf_url": "http://example.com",
"id": 0,
"total": 2147483647,
"status": "draft",
"start_on": "2019-08-24T14:15:22Z",
"end_on": "2019-08-24T14:15:22Z",
"stripe_id": "string",
"stripe_name": "string",
"currency": "str",
"line_items": [{"stripe_id": "string",
"amount": 2147483647,
"unit_amount": 2147483647,
"currency": "str",
"quantity": 2147483647,
"period_start": "2019-08-24T14:15:22Z",
"period_end": "2019-08-24T14:15:22Z",
"price": {"stripe_id": null,
"name": null,
"currency": null,
"is_active": null,
"id": null,
"unit_amount": null,
"billing_scheme": null,
"tiers": { },
"currency_options": { },
"product": null,
"description": null
},
"description": "string",
"proration": true,
"id": 0
}
],
"last_payment_intent": {"stripe_id": "string",
"invoice": 0,
"amount": 2147483647,
"currency": "str",
"description": "string",
"status": "requires_payment_method",
"last_payment_error_code": "string",
"last_payment_error_decline_code": "string",
"last_payment_error_message": "string",
"last_payment_error_type": "api_error"
}
}
},
"payment_methods": [{"stripe_id": "string",
"payment_method_type": "string",
"card_brand": "string",
"card_country": "st",
"card_exp_month": "st",
"card_exp_year": "stri",
"card_funding": "credit",
"card_last4": "stri",
"created_on": "2019-08-24T14:15:22Z"
}
],
"country": "AF"
},
"groups": [{"id": 0,
"name": "string"
}
],
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z",
"notify_when_msg_comes_in_after_hours": true,
"inbox_contact_info_fields": {"property1": null,
"property2": null
}
},
"is_active": true,
"flow_end_action": "WEBHOOK",
"flow_webhook_url": "http://example.com",
"flow_webhook_retries": 32767,
"execution_type": "INBOUND",
"flow_execution_variables": ["string"
],
"steps": [{"flow": "92fe31c9-39b9-47ea-906d-cf09a4c3fa9a",
"name": "string",
"step_type": "CONDITIONAL",
"next_step_default_idx": 32767,
"id": 0,
"answer_type": "FREE_TEXT",
"body": "string",
"body_type": "audio",
"body_file_url": "http://example.com",
"body_file_type": "URL",
"body_file": "90ac6969-fe45-44c3-bf4f-6aad314f969c",
"answer_validation_message": "string",
"answer_instructions": "string",
"answer_options": ["string"
],
"answer_phone_default_country": "AF",
"next_step_alternate_idx": 32767,
"conditions": [0
],
"delay_type": "string",
"delay_until": "2019-08-24T14:15:22Z",
"action_request_method": "GET",
"action_request_url": "http://example.com",
"action_request_headers": {"property1": "string",
"property2": "string"
},
"action_request_params": {"property1": "string",
"property2": "string"
},
"action_request_body": "string",
"action_test_response_data": "670df78f-99c9-4f91-8a3b-467f7549c574",
"answer_allow_decimals": true,
"answer_range_min": "string",
"answer_range_max": "string",
"answer_has_range": true,
"assign_to_users": [0
],
"ordering_idx": 32767,
"has_options_from_variable": true,
"option_from_variable_value": "string",
"options_from_variable": "string",
"option_from_variable_title": "string",
"missing_options_message": "string",
"answer_options_render": "BUTTONS",
"answer_options_render_list_button_title": "string",
"answer_options_render_list_section_title": "string",
"next_steps_for_options_idx": [-2147483648
],
"contact_tags": ["string"
],
"conversation_tags": ["string"
],
"max_wait_time_amount": 32767,
"max_wait_time_unit": "MINUTE",
"time_windows": [0
],
"has_max_wait_time": true,
"set_time_window": true
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"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": {"property1": null,
"property2": null
}
},
"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,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"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": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
}
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"last_conversation": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"phone_status": "UNKNOWN",
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}
]
}

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:
application/json

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

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"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": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
}
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"last_conversation": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"phone_status": "UNKNOWN",
"contact_import": "cd949ab0-4614-4dda-91ec-54566ef1ac43"
}

Get Contact

Gets a Contact by Id.

Authorizations:

tokenAuth

path Parameters

required

string <uuid>

Responses

Response samples

Content type

application/json

{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"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": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
}
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"last_conversation": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"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

required

string <uuid>

Request Body schema:
application/json

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

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"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": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
}
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"last_conversation": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"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

required

string <uuid>

Request Body schema:
application/json

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

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"meta": {"property1": null,
"property2": null
},
"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": [{"id": 0,
"notes": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"created_on": "2019-08-24T14:15:22Z",
"created_by": {"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0
}
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"last_conversation": "string",
"default_assignees": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"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

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,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"status": "CREATED",
"assigned": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"groups": [{"id": 0,
"name": "string"
}
],
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"created_on": "2019-08-24T14:15:22Z",
"source": "INBOX"
}
]
}

Update a Conversation

Authorizations:

tokenAuth

path Parameters

required

string <uuid>

Request Body schema:
application/json

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

Payload

Content type

application/json

{"id": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"status": "CREATED",
"assigned": [{"id": 0,
"groups": [{"name": "string"
}
]
}
],
"tags": [{"name": "string"
}
]
}

Response samples

Content type

application/json

{"id": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"status": "CREATED",
"assigned": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"groups": [{"id": 0,
"name": "string"
}
],
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"created_on": "2019-08-24T14:15:22Z",
"source": "INBOX"
}

Partially update a Conversation

Authorizations:

tokenAuth

path Parameters

required

string <uuid>

Request Body schema:
application/json

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

Payload

Content type

application/json

{"id": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"status": "CREATED",
"assigned": [{"id": 0,
"groups": [{"name": "string"
}
]
}
],
"tags": [{"name": "string"
}
]
}

Response samples

Content type

application/json

{"id": "string",
"contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
"status": "CREATED",
"assigned": [{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id": 0,
"account": 0,
"groups": [{"id": 0,
"name": "string"
}
],
"profile_image": "http://example.com",
"date_joined": "2019-08-24T14:15:22Z"
}
],
"tags": [{"id": 0,
"name": "string"
}
],
"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

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_active": true,
"events": ["contact.created"
],
"target": "http://example.com"
}
]
}

Create Webhook Subscription

Creates a new Webhook Subscritption.

Authorizations:

tokenAuth

Request Body schema:
application/json

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

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Get Webhook Subscription

Gets a Webhook Subscription by Id.

Authorizations:

tokenAuth

path Parameters

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": ["contact.created"
],
"target": "http://example.com"
}

Update Webhook Subscription

Update a Webhook Subscription.

Authorizations:

tokenAuth

path Parameters

required

string <uuid>

Examples:

a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Webhook Subscription Id

The Webhook Subscription Id.

Request Body schema:
application/json

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

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_active": true,
"events": ["contact.created"
],
"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

required

string <uuid>

Examples:

a3ff7ee5-0c11-49e2-a0d6-7e316626f7b1 - Webhook Subscription Id

The Webhook Subscription Id.

Request Body schema:
application/json

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

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Delete Webhook Subscription

Delete a Webhook Subscription to stop receiving the webhooks.

Authorizations:

tokenAuth

path Parameters

required

string <uuid>

Hilos API (1.0.0)

User

List Users

Authorizations:

query Parameters

Responses

Response samples

WhatsApp

List WhatsApp Templates

Authorizations:

query Parameters

Responses

Response samples

Get WhatsApp Template

Authorizations:

path Parameters

Responses

Response samples

Delete WhatsApp Template

Authorizations:

path Parameters

Responses

Send a WhatsApp Template Message

Authorizations:

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Broadcast

List Broadcasts

Authorizations:

query Parameters

Responses

Response samples

Create Broadcasts

Authorizations:

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Get Broadcast Detail

Authorizations:

path Parameters

Responses

Response samples

Flow Execution

List Flow Execution

Authorizations:

query Parameters

Responses

Response samples

Get Flow Execution

Authorizations:

path Parameters

Responses

Response samples

Update Flow Execution

Authorizations:

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Partial Update Flow Execution

Authorizations:

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Download the Flow Execution Results in a CSV file

Authorizations:

path Parameters

Responses

Create a Flow Execution

Authorizations:

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json