Skip to main content
PUT
/
v1
/
requests
/
{uid}
Update a Request
curl --request PUT \
  --url https://api.siit.io/v1/requests/{uid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "status": "open",
  "assignee_admin": "<string>",
  "assignee_inbox": "<string>",
  "target": "<string>",
  "tags": [
    "<string>"
  ],
  "associated_apps": [
    "<string>"
  ],
  "associated_equipments": [
    "<string>"
  ],
  "custom_form_inputs": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "result": {
    "uid": "<string>",
    "admin_permalink_url": "<string>",
    "archived_at": "2023-11-07T05:31:56Z",
    "assignee_admin": "<string>",
    "assignee_admin_uid": "<string>",
    "assignee_inbox": "<string>",
    "assignee_inbox_uid": "<string>",
    "associated_apps": [
      "<string>"
    ],
    "associated_equipments": [
      "<string>"
    ],
    "approvals": [
      "<string>"
    ],
    "attachments": [
      {
        "filename": "<string>",
        "url": "<string>"
      }
    ],
    "author": "<string>",
    "author_uid": "<string>",
    "completed_at": "2023-11-07T05:31:56Z",
    "completed_by": "<string>",
    "completed_by_uid": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "custom_form_inputs": [
      {
        "label": "<string>",
        "value": "<string>"
      }
    ],
    "description": "<string>",
    "follower_uids": [
      "<string>"
    ],
    "followers": [
      "<string>"
    ],
    "friendly_id": "<string>",
    "requested_by": "<string>",
    "requested_by_uid": "<string>",
    "slack_channel_id": "<string>",
    "slack_direct_link": "<string>",
    "slack_thread_ts": "<string>",
    "slack_ts": "<string>",
    "sla_data": {
      "first_completed_at": "2023-11-07T05:31:56Z",
      "first_replied_at": "2023-11-07T05:31:56Z"
    },
    "status": "open",
    "tag_uids": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "target": "<string>",
    "target_uid": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

​
Usage

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
uid
string
required

The UID (or friendly_id) of the request

Body

application/json

Request body for updating a Request. Pass UIDs (not objects) for relationship fields.

​
title
string

The title of the Request

​
description
string | null

The description of the Request

​
priority
enum<string>
Available options:
low,
medium,
high,
urgent
​
status
enum<string>
default:open

Request status

Available options:
open,
in_progress,
waiting,
resolved,
archived
​
assignee_admin
string | null

The admin user assigned to this request. Pass the UID of the related object.

​
assignee_inbox
string | null

The team inbox assigned to this request. Pass the UID of the related object.

​
target
string | null

Service associated with this request. Pass the UID of the related object.

​
tags
string[] | null

Tags associated with this request. Pass an array of UIDs of the related objects.

​
associated_apps
string[] | null

Apps associated with this request. Pass an array of UIDs of the related objects.

​
associated_equipments
string[] | null

Equipment associated with this request. Pass an array of UIDs of the related objects.

​
custom_form_inputs
(Arbitrary input (by label) · object | Native input (by uid) · object)[] | null

Custom forms attached to this request

A custom form input item for request creation. Either "label" (arbitrary input) or "uid" (native input from service configuration) must be provided.

Response

200 - application/json

Successful

​
result
object