Pipeline Stages
Update a stage
PATCH
/
api
/
v1
/
pipelines
/
{pipeline_id}
/
pipeline_stages
/
{id}
Update a stage
curl --request PATCH \
--url https://api.evoai.app/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"pipeline_stage": {
"name": "<string>",
"color": "<string>",
"stage_type": 123,
"automation_rules": {},
"custom_fields": {}
}
}
'import requests
url = "https://api.evoai.app/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}"
payload = { "pipeline_stage": {
"name": "<string>",
"color": "<string>",
"stage_type": 123,
"automation_rules": {},
"custom_fields": {}
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
pipeline_stage: {
name: '<string>',
color: '<string>',
stage_type: 123,
automation_rules: {},
custom_fields: {}
}
})
};
fetch('https://api.evoai.app/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}', 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/{pipeline_id}/pipeline_stages/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'pipeline_stage' => [
'name' => '<string>',
'color' => '<string>',
'stage_type' => 123,
'automation_rules' => [
],
'custom_fields' => [
]
]
]),
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/{pipeline_id}/pipeline_stages/{id}"
payload := strings.NewReader("{\n \"pipeline_stage\": {\n \"name\": \"<string>\",\n \"color\": \"<string>\",\n \"stage_type\": 123,\n \"automation_rules\": {},\n \"custom_fields\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.evoai.app/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pipeline_stage\": {\n \"name\": \"<string>\",\n \"color\": \"<string>\",\n \"stage_type\": 123,\n \"automation_rules\": {},\n \"custom_fields\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pipeline_stage\": {\n \"name\": \"<string>\",\n \"color\": \"<string>\",\n \"stage_type\": 123,\n \"automation_rules\": {},\n \"custom_fields\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "770e8400-e29b-41d4-a716-446655440002",
"pipeline_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Updated Stage Name",
"color": "#10B981",
"position": 1,
"stage_type": 0,
"automation_rules": {
"description": "Updated description"
},
"custom_fields": {
"attributes": []
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:35:00Z"
},
"meta": {
"timestamp": "2024-01-15T10:35:00Z"
},
"message": "Pipeline stage updated successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing authentication token"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "You do not have permission to update this stage"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Pipeline stage not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {
"color": [
"Invalid color format"
]
}
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}",
"method": "PATCH"
}
}Autorizações
Corpo
application/json
Show child attributes
Show child attributes
⌘I
Update a stage
curl --request PATCH \
--url https://api.evoai.app/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"pipeline_stage": {
"name": "<string>",
"color": "<string>",
"stage_type": 123,
"automation_rules": {},
"custom_fields": {}
}
}
'import requests
url = "https://api.evoai.app/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}"
payload = { "pipeline_stage": {
"name": "<string>",
"color": "<string>",
"stage_type": 123,
"automation_rules": {},
"custom_fields": {}
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
pipeline_stage: {
name: '<string>',
color: '<string>',
stage_type: 123,
automation_rules: {},
custom_fields: {}
}
})
};
fetch('https://api.evoai.app/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}', 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/{pipeline_id}/pipeline_stages/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'pipeline_stage' => [
'name' => '<string>',
'color' => '<string>',
'stage_type' => 123,
'automation_rules' => [
],
'custom_fields' => [
]
]
]),
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/{pipeline_id}/pipeline_stages/{id}"
payload := strings.NewReader("{\n \"pipeline_stage\": {\n \"name\": \"<string>\",\n \"color\": \"<string>\",\n \"stage_type\": 123,\n \"automation_rules\": {},\n \"custom_fields\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.evoai.app/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pipeline_stage\": {\n \"name\": \"<string>\",\n \"color\": \"<string>\",\n \"stage_type\": 123,\n \"automation_rules\": {},\n \"custom_fields\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pipeline_stage\": {\n \"name\": \"<string>\",\n \"color\": \"<string>\",\n \"stage_type\": 123,\n \"automation_rules\": {},\n \"custom_fields\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "770e8400-e29b-41d4-a716-446655440002",
"pipeline_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Updated Stage Name",
"color": "#10B981",
"position": 1,
"stage_type": 0,
"automation_rules": {
"description": "Updated description"
},
"custom_fields": {
"attributes": []
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:35:00Z"
},
"meta": {
"timestamp": "2024-01-15T10:35:00Z"
},
"message": "Pipeline stage updated successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing authentication token"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "You do not have permission to update this stage"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Pipeline stage not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {
"color": [
"Invalid color format"
]
}
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{pipeline_id}/pipeline_stages/{id}",
"method": "PATCH"
}
}