Pipelines
Create a new pipeline
Create a pipeline with optional custom stages or default stages based on pipeline type
POST
/
api
/
v1
/
pipelines
Create a new pipeline
curl --request POST \
--url https://api.evoai.app/api/v1/pipelines \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"pipeline": {
"name": "Sales Pipeline Q1",
"pipeline_type": "sales",
"description": "Q1 sales tracking pipeline",
"visibility": "private",
"custom_fields": {
"attributes": [
"deal_value",
"closing_probability"
]
}
},
"stages": [
{
"name": "<string>",
"color": "#60A5FA",
"position": 123,
"description": "<string>"
}
],
"create_default_stages": false
}
'import requests
url = "https://api.evoai.app/api/v1/pipelines"
payload = {
"pipeline": {
"name": "Sales Pipeline Q1",
"pipeline_type": "sales",
"description": "Q1 sales tracking pipeline",
"visibility": "private",
"custom_fields": { "attributes": ["deal_value", "closing_probability"] }
},
"stages": [
{
"name": "<string>",
"color": "#60A5FA",
"position": 123,
"description": "<string>"
}
],
"create_default_stages": False
}
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({
pipeline: {
name: 'Sales Pipeline Q1',
pipeline_type: 'sales',
description: 'Q1 sales tracking pipeline',
visibility: 'private',
custom_fields: {attributes: ['deal_value', 'closing_probability']}
},
stages: [{name: '<string>', color: '#60A5FA', position: 123, description: '<string>'}],
create_default_stages: false
})
};
fetch('https://api.evoai.app/api/v1/pipelines', 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.evoai.app/api/v1/pipelines",
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([
'pipeline' => [
'name' => 'Sales Pipeline Q1',
'pipeline_type' => 'sales',
'description' => 'Q1 sales tracking pipeline',
'visibility' => 'private',
'custom_fields' => [
'attributes' => [
'deal_value',
'closing_probability'
]
]
],
'stages' => [
[
'name' => '<string>',
'color' => '#60A5FA',
'position' => 123,
'description' => '<string>'
]
],
'create_default_stages' => false
]),
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://api.evoai.app/api/v1/pipelines"
payload := strings.NewReader("{\n \"pipeline\": {\n \"name\": \"Sales Pipeline Q1\",\n \"pipeline_type\": \"sales\",\n \"description\": \"Q1 sales tracking pipeline\",\n \"visibility\": \"private\",\n \"custom_fields\": {\n \"attributes\": [\n \"deal_value\",\n \"closing_probability\"\n ]\n }\n },\n \"stages\": [\n {\n \"name\": \"<string>\",\n \"color\": \"#60A5FA\",\n \"position\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"create_default_stages\": false\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://api.evoai.app/api/v1/pipelines")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pipeline\": {\n \"name\": \"Sales Pipeline Q1\",\n \"pipeline_type\": \"sales\",\n \"description\": \"Q1 sales tracking pipeline\",\n \"visibility\": \"private\",\n \"custom_fields\": {\n \"attributes\": [\n \"deal_value\",\n \"closing_probability\"\n ]\n }\n },\n \"stages\": [\n {\n \"name\": \"<string>\",\n \"color\": \"#60A5FA\",\n \"position\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"create_default_stages\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/pipelines")
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 \"pipeline\": {\n \"name\": \"Sales Pipeline Q1\",\n \"pipeline_type\": \"sales\",\n \"description\": \"Q1 sales tracking pipeline\",\n \"visibility\": \"private\",\n \"custom_fields\": {\n \"attributes\": [\n \"deal_value\",\n \"closing_probability\"\n ]\n }\n },\n \"stages\": [\n {\n \"name\": \"<string>\",\n \"color\": \"#60A5FA\",\n \"position\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"create_default_stages\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Sales Pipeline Q1",
"pipeline_type": "sales"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z"
},
"message": "Pipeline created successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation error",
"details": {
"name": "Name is required",
"pipeline_type": "Pipeline type is required"
}
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines",
"method": "POST"
}
}Authorizations
Body
application/json
⌘I
Create a new pipeline
curl --request POST \
--url https://api.evoai.app/api/v1/pipelines \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"pipeline": {
"name": "Sales Pipeline Q1",
"pipeline_type": "sales",
"description": "Q1 sales tracking pipeline",
"visibility": "private",
"custom_fields": {
"attributes": [
"deal_value",
"closing_probability"
]
}
},
"stages": [
{
"name": "<string>",
"color": "#60A5FA",
"position": 123,
"description": "<string>"
}
],
"create_default_stages": false
}
'import requests
url = "https://api.evoai.app/api/v1/pipelines"
payload = {
"pipeline": {
"name": "Sales Pipeline Q1",
"pipeline_type": "sales",
"description": "Q1 sales tracking pipeline",
"visibility": "private",
"custom_fields": { "attributes": ["deal_value", "closing_probability"] }
},
"stages": [
{
"name": "<string>",
"color": "#60A5FA",
"position": 123,
"description": "<string>"
}
],
"create_default_stages": False
}
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({
pipeline: {
name: 'Sales Pipeline Q1',
pipeline_type: 'sales',
description: 'Q1 sales tracking pipeline',
visibility: 'private',
custom_fields: {attributes: ['deal_value', 'closing_probability']}
},
stages: [{name: '<string>', color: '#60A5FA', position: 123, description: '<string>'}],
create_default_stages: false
})
};
fetch('https://api.evoai.app/api/v1/pipelines', 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.evoai.app/api/v1/pipelines",
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([
'pipeline' => [
'name' => 'Sales Pipeline Q1',
'pipeline_type' => 'sales',
'description' => 'Q1 sales tracking pipeline',
'visibility' => 'private',
'custom_fields' => [
'attributes' => [
'deal_value',
'closing_probability'
]
]
],
'stages' => [
[
'name' => '<string>',
'color' => '#60A5FA',
'position' => 123,
'description' => '<string>'
]
],
'create_default_stages' => false
]),
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://api.evoai.app/api/v1/pipelines"
payload := strings.NewReader("{\n \"pipeline\": {\n \"name\": \"Sales Pipeline Q1\",\n \"pipeline_type\": \"sales\",\n \"description\": \"Q1 sales tracking pipeline\",\n \"visibility\": \"private\",\n \"custom_fields\": {\n \"attributes\": [\n \"deal_value\",\n \"closing_probability\"\n ]\n }\n },\n \"stages\": [\n {\n \"name\": \"<string>\",\n \"color\": \"#60A5FA\",\n \"position\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"create_default_stages\": false\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://api.evoai.app/api/v1/pipelines")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pipeline\": {\n \"name\": \"Sales Pipeline Q1\",\n \"pipeline_type\": \"sales\",\n \"description\": \"Q1 sales tracking pipeline\",\n \"visibility\": \"private\",\n \"custom_fields\": {\n \"attributes\": [\n \"deal_value\",\n \"closing_probability\"\n ]\n }\n },\n \"stages\": [\n {\n \"name\": \"<string>\",\n \"color\": \"#60A5FA\",\n \"position\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"create_default_stages\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/pipelines")
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 \"pipeline\": {\n \"name\": \"Sales Pipeline Q1\",\n \"pipeline_type\": \"sales\",\n \"description\": \"Q1 sales tracking pipeline\",\n \"visibility\": \"private\",\n \"custom_fields\": {\n \"attributes\": [\n \"deal_value\",\n \"closing_probability\"\n ]\n }\n },\n \"stages\": [\n {\n \"name\": \"<string>\",\n \"color\": \"#60A5FA\",\n \"position\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"create_default_stages\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Sales Pipeline Q1",
"pipeline_type": "sales"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z"
},
"message": "Pipeline created successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation error",
"details": {
"name": "Name is required",
"pipeline_type": "Pipeline type is required"
}
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines",
"method": "POST"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines",
"method": "POST"
}
}