Update

Update

curl --request PATCH \
  --url https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "order_position": 1,
  "is_active": true,
  "color": "<string>",
  "pre_condition_fields": [
    "<string>"
  ],
  "pre_condition_rules": [
    {}
  ]
}
'

import requests

url = "https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "order_position": 1,
    "is_active": True,
    "color": "<string>",
    "pre_condition_fields": ["<string>"],
    "pre_condition_rules": [{}]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    order_position: 1,
    is_active: true,
    color: '<string>',
    pre_condition_fields: ['<string>'],
    pre_condition_rules: [{}]
  })
};

fetch('https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{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([
    'name' => '<string>',
    'description' => '<string>',
    'order_position' => 1,
    'is_active' => true,
    'color' => '<string>',
    'pre_condition_fields' => [
        '<string>'
    ],
    'pre_condition_rules' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"order_position\": 1,\n  \"is_active\": true,\n  \"color\": \"<string>\",\n  \"pre_condition_fields\": [\n    \"<string>\"\n  ],\n  \"pre_condition_rules\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"order_position\": 1,\n  \"is_active\": true,\n  \"color\": \"<string>\",\n  \"pre_condition_fields\": [\n    \"<string>\"\n  ],\n  \"pre_condition_rules\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"order_position\": 1,\n  \"is_active\": true,\n  \"color\": \"<string>\",\n  \"pre_condition_fields\": [\n    \"<string>\"\n  ],\n  \"pre_condition_rules\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "status": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "order_position": 123,
      "is_active": true,
      "color": "<string>",
      "pre_condition_fields": [
        "<string>"
      ],
      "pre_condition_rules": [
        {}
      ]
    }
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "details": {
      "fields": {
        "first_name": "First name is required"
      }
    }
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "AUTH_INVALID_KEY",
    "message": "Invalid API key"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Retry after 12 seconds.",
    "details": {
      "limit": 60,
      "remaining": 0,
      "reset": 1718400000000,
      "retry_after": 12
    }
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

PATCH

settings

statuses

{object}

{id}

Update

curl --request PATCH \
  --url https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "order_position": 1,
  "is_active": true,
  "color": "<string>",
  "pre_condition_fields": [
    "<string>"
  ],
  "pre_condition_rules": [
    {}
  ]
}
'

import requests

url = "https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "order_position": 1,
    "is_active": True,
    "color": "<string>",
    "pre_condition_fields": ["<string>"],
    "pre_condition_rules": [{}]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    order_position: 1,
    is_active: true,
    color: '<string>',
    pre_condition_fields: ['<string>'],
    pre_condition_rules: [{}]
  })
};

fetch('https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{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([
    'name' => '<string>',
    'description' => '<string>',
    'order_position' => 1,
    'is_active' => true,
    'color' => '<string>',
    'pre_condition_fields' => [
        '<string>'
    ],
    'pre_condition_rules' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"order_position\": 1,\n  \"is_active\": true,\n  \"color\": \"<string>\",\n  \"pre_condition_fields\": [\n    \"<string>\"\n  ],\n  \"pre_condition_rules\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"order_position\": 1,\n  \"is_active\": true,\n  \"color\": \"<string>\",\n  \"pre_condition_fields\": [\n    \"<string>\"\n  ],\n  \"pre_condition_rules\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/settings/statuses/{object}/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"order_position\": 1,\n  \"is_active\": true,\n  \"color\": \"<string>\",\n  \"pre_condition_fields\": [\n    \"<string>\"\n  ],\n  \"pre_condition_rules\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "status": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "order_position": 123,
      "is_active": true,
      "color": "<string>",
      "pre_condition_fields": [
        "<string>"
      ],
      "pre_condition_rules": [
        {}
      ]
    }
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "details": {
      "fields": {
        "first_name": "First name is required"
      }
    }
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "AUTH_INVALID_KEY",
    "message": "Invalid API key"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Retry after 12 seconds.",
    "details": {
      "limit": 60,
      "remaining": 0,
      "reset": 1718400000000,
      "retry_after": 12
    }
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

Authorizations

x-api-key

string

header

required

API key from Settings > API Keys or POST /v1/api-keys. Format f9_live_<32 hex chars> (live) or f9_test_<32 hex chars> (sandbox — no real sends, ever). Legacy wcrm_live_ / wcrm_test_ keys still authenticate but are no longer issued. Shown once at creation; only a hash is stored.

Path Parameters

object

enum<string>

required

Available options:

leads,

deals

string<uuid>

required

Body

application/json

name

string

Required on create; unique per pipeline (case-insensitive).

description

string | null

order_position

integer

Defaults to the next position on create.

Required range: x >= 0

is_active

boolean

color

string

#RRGGBB

pre_condition_fields

string[]

pre_condition_rules

object[]

Response

Updated

success

enum<boolean>

Available options:

true

data

object

Show child attributes

Getting started

Working with data

Workspace administration

Communications & scheduling

Connect an application

Endpoints

Authorizations

Path Parameters

Body

Response