Pipelines
Create a pipeline
Creates a new pipeline (funnel).
POST
/
api
/
v1
/
accounts
/
{account_id}
/
funnels
Create a pipeline
curl --request POST \
--url https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"name": "Sales Pipeline",
"description": "Main B2B sales pipeline.",
"color": "#4CAF50",
"position": 1,
"is_public": true,
"is_active": true
}
'import requests
url = "https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels"
payload = {
"name": "Sales Pipeline",
"description": "Main B2B sales pipeline.",
"color": "#4CAF50",
"position": 1,
"is_public": True,
"is_active": True
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Sales Pipeline',
description: 'Main B2B sales pipeline.',
color: '#4CAF50',
position: 1,
is_public: true,
is_active: true
})
};
fetch('https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels', 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://connect.voxys.ai/api/v1/accounts/{account_id}/funnels",
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([
'name' => 'Sales Pipeline',
'description' => 'Main B2B sales pipeline.',
'color' => '#4CAF50',
'position' => 1,
'is_public' => true,
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <api-key>"
],
]);
$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://connect.voxys.ai/api/v1/accounts/{account_id}/funnels"
payload := strings.NewReader("{\n \"name\": \"Sales Pipeline\",\n \"description\": \"Main B2B sales pipeline.\",\n \"color\": \"#4CAF50\",\n \"position\": 1,\n \"is_public\": true,\n \"is_active\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_access_token", "<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://connect.voxys.ai/api/v1/accounts/{account_id}/funnels")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Sales Pipeline\",\n \"description\": \"Main B2B sales pipeline.\",\n \"color\": \"#4CAF50\",\n \"position\": 1,\n \"is_public\": true,\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Sales Pipeline\",\n \"description\": \"Main B2B sales pipeline.\",\n \"color\": \"#4CAF50\",\n \"position\": 1,\n \"is_public\": true,\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 3,
"name": "Sales Pipeline",
"description": "Main B2B sales pipeline.",
"color": "#4CAF50",
"position": 1,
"is_public": true,
"is_active": true,
"stages_count": 5,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Unauthorized"
}{
"errors": {
"name": [
"can't be blank"
]
}
}Authorizations
API access token for authentication. Obtain from your Voxys Connect profile settings.
Path Parameters
The numeric ID of the account.
Body
application/json
Response
Pipeline created.
Example:
3
Example:
"Sales Pipeline"
Example:
"Main B2B sales pipeline."
Example:
"#4CAF50"
Example:
1
Example:
true
Example:
true
Example:
5
⌘I
Create a pipeline
curl --request POST \
--url https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"name": "Sales Pipeline",
"description": "Main B2B sales pipeline.",
"color": "#4CAF50",
"position": 1,
"is_public": true,
"is_active": true
}
'import requests
url = "https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels"
payload = {
"name": "Sales Pipeline",
"description": "Main B2B sales pipeline.",
"color": "#4CAF50",
"position": 1,
"is_public": True,
"is_active": True
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Sales Pipeline',
description: 'Main B2B sales pipeline.',
color: '#4CAF50',
position: 1,
is_public: true,
is_active: true
})
};
fetch('https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels', 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://connect.voxys.ai/api/v1/accounts/{account_id}/funnels",
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([
'name' => 'Sales Pipeline',
'description' => 'Main B2B sales pipeline.',
'color' => '#4CAF50',
'position' => 1,
'is_public' => true,
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <api-key>"
],
]);
$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://connect.voxys.ai/api/v1/accounts/{account_id}/funnels"
payload := strings.NewReader("{\n \"name\": \"Sales Pipeline\",\n \"description\": \"Main B2B sales pipeline.\",\n \"color\": \"#4CAF50\",\n \"position\": 1,\n \"is_public\": true,\n \"is_active\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_access_token", "<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://connect.voxys.ai/api/v1/accounts/{account_id}/funnels")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Sales Pipeline\",\n \"description\": \"Main B2B sales pipeline.\",\n \"color\": \"#4CAF50\",\n \"position\": 1,\n \"is_public\": true,\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.voxys.ai/api/v1/accounts/{account_id}/funnels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Sales Pipeline\",\n \"description\": \"Main B2B sales pipeline.\",\n \"color\": \"#4CAF50\",\n \"position\": 1,\n \"is_public\": true,\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 3,
"name": "Sales Pipeline",
"description": "Main B2B sales pipeline.",
"color": "#4CAF50",
"position": 1,
"is_public": true,
"is_active": true,
"stages_count": 5,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Unauthorized"
}{
"errors": {
"name": [
"can't be blank"
]
}
}
