Set a status

Update a status by Key¶

POST https://api.stativate.de/v1/status-keys/:statusKey

Required authorization level: Verified

Description¶

Creates or updates a status. If a status for the requested key alread exists, the status is updated. If no status for the requested key exists, a new status with that key is created.

Info

See the docs on status identifiers to learn if using status id or status key is best for your case.

Example

See the create or update status tutorial for an example how to use this endpoint.

Request Path - Parameters¶

Name	Type	Description
:statusKey	`String`	The status Key of the status

Request Body - Parameters¶

Name	Type	Description
name (optional)	`string`	Status name Size range: 3-42
type (optional)	`string`	Status type. This defines that this status has a value of type text. Allowed values: "text"
value (optional)	`string`	Status value Size range: 1-10
accessType (optional)	`string`	Defines if the status is private or public Allowed values: "public","private"
description (optional)	`string`	Status description text. The text is only allowed to contain links if your plan allows it. Size range: max 400
colorNo (optional)	`number`	Status color as a number Size range: 1 to 12
accessTypeUserList (optional)	`string`	Defines the level of access to the user list of this status Allowed values: "public","private","owner" Check availability in your plan
accessTypeHistory (optional)	`string`	Defines the level of access to the history of this status Allowed values: "public","private","owner" Check availability in your plan

Response Body - Parameters¶

Name	Type	Description
id	`string`	The status id
shareID	`string`	The share id for the status
name	`string`	Status name
type	`string`	Status type
value	`string`	Status value
accessType	`string`	Status access type
description	`string`	Status description text
colorNo	`number`	Status color as a number
accessTypeUserList	`string`	Level of access to the user list of this status Check availability in your plan
accessTypeHistory	`string`	Level of access to the history of this status Check availability in your plan

Examples¶

Parameter examples¶

Request body example updating a status value:

{
    "value": "TODAY",
}

Request body example updating a status:

{
    "name": "Delivery Order #1234",
    "type": "text",
    "value": "TODAY",
    "accessType": "private",
    "description": "We will keep you updated about your order #1234 here.",
    "colorNo": 3
}

Success response examples¶

Success response example - `Success (200):`¶

{
    "id": "SPbi7aNV4s0w0BExample",
    "shareId": "7v7x3e",
    "name": "Delivery Order #1234",
    "value": "TODAY",
    "type": "text",
    "accessType": "private",
    "description": "We will keep you updated about your order #1234 here.",
    "colorNo": 3,
    "accessTypeUserList": "owners",
    "accessTypeHistory": "private"
}