Simple status value update¶

We designed the Stativate API to be as simple as possible and to get out of your way. The simplest yet powerful thing to do is to keep an existing status updated by automatically sending new status values over the API.

To update the status value, we will send a simple PATCH request in this tutorial. The request body could not be any simpler, we will simply send the new value:

{ "value": "80%" }

So let's walk through this step by step.

1. Create the status¶

This example assumes you created a status in the Stativate application, that you want to update using the API.

Create a new status using one of the Stativate applications. Skip this step if the status you want to update already exists.

2. Find the statusId to update¶

To get the statusId of your status you can use the list status endpoint. That will give you a list of status you own. Look for the right status name to find the statusId in the list.

GET https://api.stativate.de/v1/user/status

This will give you a response like

[
  {
    "statusId": "A0aEMOe6n7qMhcExample",
    "statusKey": null,
    "shareId": "xkwd5e",
    "name": "Status One"
  }
]

The statusId property of your status in the response is the :statusId value for the next step.

3. Update the status value¶

Updating a status value is very straightforward. You just send a new value to

PATCH https://api.stativate.de/v1/status/:statusId

with a request body that could not be any simpler:

{ "value": "80%" }

The request including authentication might look like this:

curl https://api.stativate.de/v1/status/:statusId \
-H "stativate-api-key: {your API Key here}" \
-H "Content-Type: application/json" \
-X PATCH \
-d '{ "value" : "80%" }'

That's it. If everything went well you successfully updated the status value using the Stativate API.

{
  "value": "80%",
  "description": "An important milestone, thank you all. Now let's go for 90%."
}