Skip to main content
PUT
/
v2
/
status
Update Status
curl --request PUT \
  --url https://api.sonderplan.com/v2/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Confirmed",
  "description": "The confirmed status",
  "type_id": 1,
  "notification": true,
  "order": 3,
  "color_background": "#B0A7F1",
  "color_text": "#000000"
}
'
{
  "success": {
    "id": 2384
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string
required

The ID of the status you wish to update

Body

application/json

Status model

​
name
string

The status name

Example:

"Confirmed"

​
description
string

Description of what the status represents

Example:

"The confirmed status"

​
type_id
integer

Status type: 1 = Booking, 2 = Project (Future Use)

Example:

1

​
notification
boolean

Are booking notifications triggered when this status is selected

Example:

true

​
order
integer

Specify the order of the status with an integer in ascending order

Example:

3

​
color_background
string

A hex color value of the background of this project

Example:

"#B0A7F1"

​
color_text
string

A hex color value of the text of this project

Example:

"#000000"

Response

Successful Operation

​
success
object