Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Rename a pipeline.
crm.pipelines:write scope.| Field | Type | Required | Notes |
|---|---|---|---|
pipeline_id | integer | Yes | The pipeline’s id. |
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | Yes | Its new name. Up to 100 characters, and not a name another of the account’s pipelines has. |
curl -X PATCH "https://api.fireflo.au/v1/crm/pipelines/3" \
-H "Authorization: Bearer $OMNI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Retail sales — South"
}'
import os
import requests
response = requests.patch(
"https://api.fireflo.au/v1/crm/pipelines/3",
headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
json={
"name": "Retail sales — South"
},
)
print(response.status_code, response.json())
const response = await fetch("https://api.fireflo.au/v1/crm/pipelines/3", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.OMNI_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "Retail sales — South"
}),
});
console.log(response.status, await response.json());
200 OK — the pipeline.
{
"id": 3,
"name": "Retail sales — South",
"order": 0,
"stages": [
{
"id": 11,
"name": "New",
"order": 0,
"outcome": ""
},
{
"id": 12,
"name": "Contacted",
"order": 1,
"outcome": ""
},
{
"id": 13,
"name": "Proposal",
"order": 2,
"outcome": ""
},
{
"id": 14,
"name": "Won",
"order": 3,
"outcome": "won"
},
{
"id": 15,
"name": "Lost",
"order": 4,
"outcome": "lost"
}
],
"created_at": "2026-09-14T10:02:17+05:30"
}
{"error": {"code", "message", "field"}}; field is there when one input is at fault.
| Status | Error code | When |
|---|---|---|
| 400 | invalid_request | name is missing, empty, longer than 100 characters, or another pipeline’s (field is name). |
| 404 | not_found | No pipeline of this account’s has that id. |
| 404 | module_off | The account doesn’t have Pipelines on. |
| 403 | scope_missing | The key doesn’t have the crm.pipelines:write scope. |
key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.