Create a Flow Execution
curl --request POST \
--url https://api.hilos.io/api/flow/{id}/run \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"execute_for": "LIST",
"contact_list": [
{
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"meta": {},
"external_url": "<string>",
"is_deleted": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "website",
"created_on": "2023-11-07T05:31:56Z",
"tags": [
{
"name": "<string>"
}
],
"external_id": "<string>",
"native_id": "<string>",
"default_assignees": [
123
],
"contact_import": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"default_channel": 123,
"wa_id": "<string>",
"overwrite_tags": false,
"overwrite_default_assignees": false,
"overwrite_meta": false
}
],
"has_priority": false
}
'import requests
url = "https://api.hilos.io/api/flow/{id}/run"
payload = {
"execute_for": "LIST",
"contact_list": [
{
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"meta": {},
"external_url": "<string>",
"is_deleted": True,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "website",
"created_on": "2023-11-07T05:31:56Z",
"tags": [{ "name": "<string>" }],
"external_id": "<string>",
"native_id": "<string>",
"default_assignees": [123],
"contact_import": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"default_channel": 123,
"wa_id": "<string>",
"overwrite_tags": False,
"overwrite_default_assignees": False,
"overwrite_meta": False
}
],
"has_priority": False
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
execute_for: 'LIST',
contact_list: [
{
phone: '<string>',
first_name: '<string>',
last_name: '<string>',
email: 'jsmith@example.com',
meta: {},
external_url: '<string>',
is_deleted: true,
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source: 'website',
created_on: '2023-11-07T05:31:56Z',
tags: [{name: '<string>'}],
external_id: '<string>',
native_id: '<string>',
default_assignees: [123],
contact_import: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
default_channel: 123,
wa_id: '<string>',
overwrite_tags: false,
overwrite_default_assignees: false,
overwrite_meta: false
}
],
has_priority: false
})
};
fetch('https://api.hilos.io/api/flow/{id}/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hilos.io/api/flow/{id}/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'execute_for' => 'LIST',
'contact_list' => [
[
'phone' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'email' => 'jsmith@example.com',
'meta' => [
],
'external_url' => '<string>',
'is_deleted' => true,
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source' => 'website',
'created_on' => '2023-11-07T05:31:56Z',
'tags' => [
[
'name' => '<string>'
]
],
'external_id' => '<string>',
'native_id' => '<string>',
'default_assignees' => [
123
],
'contact_import' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'default_channel' => 123,
'wa_id' => '<string>',
'overwrite_tags' => false,
'overwrite_default_assignees' => false,
'overwrite_meta' => false
]
],
'has_priority' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hilos.io/api/flow/{id}/run"
payload := strings.NewReader("{\n \"execute_for\": \"LIST\",\n \"contact_list\": [\n {\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"meta\": {},\n \"external_url\": \"<string>\",\n \"is_deleted\": true,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source\": \"website\",\n \"created_on\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"external_id\": \"<string>\",\n \"native_id\": \"<string>\",\n \"default_assignees\": [\n 123\n ],\n \"contact_import\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"default_channel\": 123,\n \"wa_id\": \"<string>\",\n \"overwrite_tags\": false,\n \"overwrite_default_assignees\": false,\n \"overwrite_meta\": false\n }\n ],\n \"has_priority\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hilos.io/api/flow/{id}/run")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"execute_for\": \"LIST\",\n \"contact_list\": [\n {\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"meta\": {},\n \"external_url\": \"<string>\",\n \"is_deleted\": true,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source\": \"website\",\n \"created_on\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"external_id\": \"<string>\",\n \"native_id\": \"<string>\",\n \"default_assignees\": [\n 123\n ],\n \"contact_import\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"default_channel\": 123,\n \"wa_id\": \"<string>\",\n \"overwrite_tags\": false,\n \"overwrite_default_assignees\": false,\n \"overwrite_meta\": false\n }\n ],\n \"has_priority\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hilos.io/api/flow/{id}/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"execute_for\": \"LIST\",\n \"contact_list\": [\n {\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"meta\": {},\n \"external_url\": \"<string>\",\n \"is_deleted\": true,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source\": \"website\",\n \"created_on\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"external_id\": \"<string>\",\n \"native_id\": \"<string>\",\n \"default_assignees\": [\n 123\n ],\n \"contact_import\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"default_channel\": 123,\n \"wa_id\": \"<string>\",\n \"overwrite_tags\": false,\n \"overwrite_default_assignees\": false,\n \"overwrite_meta\": false\n }\n ],\n \"has_priority\": false\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"execute_for": "FILTERS",
"inbound_trigger_with": "ANY_MESSAGE",
"inbound_start_message": "<string>",
"inbound_start_message_match_exact": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"has_priority": true,
"flow_execution_variables": {},
"start_on": "2023-11-07T05:31:56Z",
"num_contacts": 1073741823,
"expired": 1073741823,
"running": 1073741823,
"completed": 1073741823,
"canceled": 1073741823,
"failed": 1073741823,
"created_on": "2023-11-07T05:31:56Z",
"avg_completion_time": "<string>",
"contact_filters": [
{
"field": "<string>",
"comparison": "exact",
"value": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"contact_list": [
{
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"meta": {},
"external_url": "<string>",
"is_deleted": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "website",
"notes": [
{
"id": 123,
"notes": "<string>",
"contact": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_on": "2023-11-07T05:31:56Z",
"created_by": {
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"profile_image": "<string>",
"role": "AGENT"
}
}
],
"created_on": "2023-11-07T05:31:56Z",
"tags": [
{
"id": 123,
"name": "<string>"
}
],
"external_id": "<string>",
"native_id": "<string>",
"default_assignees": [
123
],
"contact_import": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"default_channel": 123,
"wa_id": "<string>",
"overwrite_tags": false,
"overwrite_default_assignees": false,
"overwrite_meta": false
}
],
"source": "HUBSPOT",
"is_hidden": true
}Flow Execution
Create a flow execution
Create a Flow Execution of a Flow.
POST
/
api
/
flow
/
{id}
/
run
Create a Flow Execution
curl --request POST \
--url https://api.hilos.io/api/flow/{id}/run \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"execute_for": "LIST",
"contact_list": [
{
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"meta": {},
"external_url": "<string>",
"is_deleted": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "website",
"created_on": "2023-11-07T05:31:56Z",
"tags": [
{
"name": "<string>"
}
],
"external_id": "<string>",
"native_id": "<string>",
"default_assignees": [
123
],
"contact_import": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"default_channel": 123,
"wa_id": "<string>",
"overwrite_tags": false,
"overwrite_default_assignees": false,
"overwrite_meta": false
}
],
"has_priority": false
}
'import requests
url = "https://api.hilos.io/api/flow/{id}/run"
payload = {
"execute_for": "LIST",
"contact_list": [
{
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"meta": {},
"external_url": "<string>",
"is_deleted": True,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "website",
"created_on": "2023-11-07T05:31:56Z",
"tags": [{ "name": "<string>" }],
"external_id": "<string>",
"native_id": "<string>",
"default_assignees": [123],
"contact_import": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"default_channel": 123,
"wa_id": "<string>",
"overwrite_tags": False,
"overwrite_default_assignees": False,
"overwrite_meta": False
}
],
"has_priority": False
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
execute_for: 'LIST',
contact_list: [
{
phone: '<string>',
first_name: '<string>',
last_name: '<string>',
email: 'jsmith@example.com',
meta: {},
external_url: '<string>',
is_deleted: true,
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source: 'website',
created_on: '2023-11-07T05:31:56Z',
tags: [{name: '<string>'}],
external_id: '<string>',
native_id: '<string>',
default_assignees: [123],
contact_import: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
default_channel: 123,
wa_id: '<string>',
overwrite_tags: false,
overwrite_default_assignees: false,
overwrite_meta: false
}
],
has_priority: false
})
};
fetch('https://api.hilos.io/api/flow/{id}/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hilos.io/api/flow/{id}/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'execute_for' => 'LIST',
'contact_list' => [
[
'phone' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'email' => 'jsmith@example.com',
'meta' => [
],
'external_url' => '<string>',
'is_deleted' => true,
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source' => 'website',
'created_on' => '2023-11-07T05:31:56Z',
'tags' => [
[
'name' => '<string>'
]
],
'external_id' => '<string>',
'native_id' => '<string>',
'default_assignees' => [
123
],
'contact_import' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'default_channel' => 123,
'wa_id' => '<string>',
'overwrite_tags' => false,
'overwrite_default_assignees' => false,
'overwrite_meta' => false
]
],
'has_priority' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hilos.io/api/flow/{id}/run"
payload := strings.NewReader("{\n \"execute_for\": \"LIST\",\n \"contact_list\": [\n {\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"meta\": {},\n \"external_url\": \"<string>\",\n \"is_deleted\": true,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source\": \"website\",\n \"created_on\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"external_id\": \"<string>\",\n \"native_id\": \"<string>\",\n \"default_assignees\": [\n 123\n ],\n \"contact_import\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"default_channel\": 123,\n \"wa_id\": \"<string>\",\n \"overwrite_tags\": false,\n \"overwrite_default_assignees\": false,\n \"overwrite_meta\": false\n }\n ],\n \"has_priority\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hilos.io/api/flow/{id}/run")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"execute_for\": \"LIST\",\n \"contact_list\": [\n {\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"meta\": {},\n \"external_url\": \"<string>\",\n \"is_deleted\": true,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source\": \"website\",\n \"created_on\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"external_id\": \"<string>\",\n \"native_id\": \"<string>\",\n \"default_assignees\": [\n 123\n ],\n \"contact_import\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"default_channel\": 123,\n \"wa_id\": \"<string>\",\n \"overwrite_tags\": false,\n \"overwrite_default_assignees\": false,\n \"overwrite_meta\": false\n }\n ],\n \"has_priority\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hilos.io/api/flow/{id}/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"execute_for\": \"LIST\",\n \"contact_list\": [\n {\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"meta\": {},\n \"external_url\": \"<string>\",\n \"is_deleted\": true,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source\": \"website\",\n \"created_on\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n {\n \"name\": \"<string>\"\n }\n ],\n \"external_id\": \"<string>\",\n \"native_id\": \"<string>\",\n \"default_assignees\": [\n 123\n ],\n \"contact_import\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"default_channel\": 123,\n \"wa_id\": \"<string>\",\n \"overwrite_tags\": false,\n \"overwrite_default_assignees\": false,\n \"overwrite_meta\": false\n }\n ],\n \"has_priority\": false\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"execute_for": "FILTERS",
"inbound_trigger_with": "ANY_MESSAGE",
"inbound_start_message": "<string>",
"inbound_start_message_match_exact": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"has_priority": true,
"flow_execution_variables": {},
"start_on": "2023-11-07T05:31:56Z",
"num_contacts": 1073741823,
"expired": 1073741823,
"running": 1073741823,
"completed": 1073741823,
"canceled": 1073741823,
"failed": 1073741823,
"created_on": "2023-11-07T05:31:56Z",
"avg_completion_time": "<string>",
"contact_filters": [
{
"field": "<string>",
"comparison": "exact",
"value": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"contact_list": [
{
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"meta": {},
"external_url": "<string>",
"is_deleted": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "website",
"notes": [
{
"id": 123,
"notes": "<string>",
"contact": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_on": "2023-11-07T05:31:56Z",
"created_by": {
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"profile_image": "<string>",
"role": "AGENT"
}
}
],
"created_on": "2023-11-07T05:31:56Z",
"tags": [
{
"id": 123,
"name": "<string>"
}
],
"external_id": "<string>",
"native_id": "<string>",
"default_assignees": [
123
],
"contact_import": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"default_channel": 123,
"wa_id": "<string>",
"overwrite_tags": false,
"overwrite_default_assignees": false,
"overwrite_meta": false
}
],
"source": "HUBSPOT",
"is_hidden": true
}Authorizations
Token-based authentication with required prefix "Token"
Path Parameters
A Flow Id to create a Flow Execution.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Response
201 - application/json
The status of the Flow Execution.
Available options:
FILTERS, LIST, ALL Available options:
ANY_MESSAGE, TEXT, IMAGE, FILE Show child attributes
Show child attributes
Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647The filters to use to get the Contacts that the Flow Execution will run for.
Show child attributes
Show child attributes
The list of Contacts that the Flow Execution will run for.
Show child attributes
Show child attributes
Available options:
HUBSPOT, API, FRONTEND Was this page helpful?