Skip to main content
POST
Create or update a partner status variant

Authorizations

Authorization
string
header
required

Partner API key (e.g. nerds_live_a8f3d9k2m5n7p1q4r6t8v0w2x4y6z8)

Body

application/json

Create or update a partner-specific status variant. The mapped_status maps this variant to one of the 6 internal categories.

id
string
required

Machine-readable status identifier (unique per partner)

Required string length: 1 - 256
Example:

"waiting_on_customer"

label
string
required

Human-readable display label

Required string length: 1 - 128
Example:

"Waiting on Customer"

mapped_status
enum<string>
required

Internal category this status maps to

Available options:
new,
open,
pending,
hold,
solved,
closed
Example:

"pending"

source_system
string | null

Which CRM or source system this status originates from

Maximum string length: 256
Example:

"freshdesk"

status
enum<string>
default:active

Set to inactive to soft-delete

Available options:
active,
inactive

Response

Status variant updated

success
boolean
Example:

true

data
object
message
string
Example:

"Status variant created successfully"