SNsnipeitapp

/statuslabels/:id

Changed on

Updates selected fields in a status label

patch/statuslabels/{id}

Request

  • Base URL
    https://develop.snipeitapp.com/api/v1
  • URL
    https://develop.snipeitapp.com/api/v1/statuslabels/{id}
  • Auth
    none required

Path parameters

idinteger required

Request body

namestring required
type'deployable' | 'pending' | 'archived' | 'undeployable'
notesstring
colorstring

Hex code showing what color the status label should be on the pie chart in the dashboard

show_in_navboolean

1 or 0 - determine whether the status label should show in the left-side nav of the web GUI

default_labelboolean

1 or 0 - determine whether it should be bubbled up to the top of the list of available statuses

Response

200

statusstring
messagesstring

Example response

{
  "status": "success",
  "messages": "Status Label created successfully.",
  "payload": {
    "name": "Test Status Label",
    "deployable": 1,
    "updated_at": "2017-11-22 10:37:07",
    "created_at": "2017-11-22 10:37:07",
    "id": 8
  }
}

Changes