Skip to main content
PUT
Edit Status

Path Parameters

status
integer
required

The status ID

Body

application/json
name
string
sort_order
integer | null
description
string | null
short_description
string | null
long_description
string | null
terms_conditions
string | null
icon
string | null
image_url
string | null
earn_instructions
string | null
internal_notes
string | null
colour
string | null
text_colour
string | null
code
string | null
group_name
string | null
group_handle
string | null
timezone
string | null
period
integer | null
period_type
enum<string>
Available options:
days,
weeks,
months,
years,
absolute_date,
absolute_week,
absolute_month
absolute_expiry
string | null
primary_colour
string | null
Pattern: ^#[A-Fa-f0-9]{6}$
secondary_colour
string | null
Pattern: ^#[A-Fa-f0-9]{6}$
custom_fields
object[]

Response

StatusOriginal

data
StatusOriginal · object
required