Pipelines
Archive a pipeline
Set pipeline as inactive
PATCH
/
api
/
v1
/
pipelines
/
{id}
/
archive
Archive a pipeline
curl --request PATCH \
--url https://api.evoai.app/api/v1/pipelines/{id}/archive \
--header 'api_access_token: <api-key>'import requests
url = "https://api.evoai.app/api/v1/pipelines/{id}/archive"
headers = {"api_access_token": "<api-key>"}
response = requests.patch(url, headers=headers)
print(response.text)const options = {method: 'PATCH', headers: {api_access_token: '<api-key>'}};
fetch('https://api.evoai.app/api/v1/pipelines/{id}/archive', 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/{id}/archive",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.evoai.app/api/v1/pipelines/{id}/archive"
req, _ := http.NewRequest("PATCH", url, nil)
req.Header.Add("api_access_token", "<api-key>")
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/{id}/archive")
.header("api_access_token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/pipelines/{id}/archive")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "e8a01c36-f4d7-46fe-9883-6f2264cdf9bc",
"name": "BUSSINESS",
"account_id": "37a1e39b-3579-47c2-bbb3-84829deae585",
"created_by_id": "fc8ec60f-904f-4793-878d-e1534bcedee5",
"description": "No conversation in this stage",
"pipeline_type": "sales",
"visibility": "private",
"is_active": false,
"custom_fields": {
"attributes": []
},
"item_count": 0,
"conversations_count": 0,
"created_at": "2026-01-27T17:48:46Z",
"updated_at": "2026-02-05T17:48:38Z"
},
"meta": {
"timestamp": "2026-02-05T17:49:34Z"
},
"message": "Pipeline archived successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{id}/archive",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{id}/archive",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{id}/archive",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Pipeline not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{id}/archive",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{id}/archive",
"method": "PATCH"
}
}Authorizations
Path Parameters
⌘I
Archive a pipeline
curl --request PATCH \
--url https://api.evoai.app/api/v1/pipelines/{id}/archive \
--header 'api_access_token: <api-key>'import requests
url = "https://api.evoai.app/api/v1/pipelines/{id}/archive"
headers = {"api_access_token": "<api-key>"}
response = requests.patch(url, headers=headers)
print(response.text)const options = {method: 'PATCH', headers: {api_access_token: '<api-key>'}};
fetch('https://api.evoai.app/api/v1/pipelines/{id}/archive', 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/{id}/archive",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.evoai.app/api/v1/pipelines/{id}/archive"
req, _ := http.NewRequest("PATCH", url, nil)
req.Header.Add("api_access_token", "<api-key>")
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/{id}/archive")
.header("api_access_token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/pipelines/{id}/archive")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "e8a01c36-f4d7-46fe-9883-6f2264cdf9bc",
"name": "BUSSINESS",
"account_id": "37a1e39b-3579-47c2-bbb3-84829deae585",
"created_by_id": "fc8ec60f-904f-4793-878d-e1534bcedee5",
"description": "No conversation in this stage",
"pipeline_type": "sales",
"visibility": "private",
"is_active": false,
"custom_fields": {
"attributes": []
},
"item_count": 0,
"conversations_count": 0,
"created_at": "2026-01-27T17:48:46Z",
"updated_at": "2026-02-05T17:48:38Z"
},
"meta": {
"timestamp": "2026-02-05T17:49:34Z"
},
"message": "Pipeline archived successfully"
}{
"success": false,
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{id}/archive",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{id}/archive",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{id}/archive",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Pipeline not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{id}/archive",
"method": "PATCH"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/pipelines/{id}/archive",
"method": "PATCH"
}
}