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 '
{
  "assignee_admin": "<string>",
  "assignee_admin_uid": "<string>",
  "assignee_inbox": "<string>",
  "assignee_inbox_uid": "<string>",
  "associated_apps": [
    "<string>"
  ],
  "associated_equipments": [
    "<string>"
  ],
  "attachments": [
    {
      "filename": "<string>",
      "url": "<string>"
    }
  ],
  "description": "<string>",
  "follower_uids": [
    "<string>"
  ],
  "followers": [
    "<string>"
  ],
  "priority": "low",
  "requested_by": "<string>",
  "status": "open",
  "tag_uids": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "target": "<string>",
  "target_uid": "<string>",
  "title": "<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>"
    ],
    "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": [
      {
        "kind": "attachment",
        "label": "<string>",
        "value": "<string>"
      }
    ],
    "description": "<string>",
    "follower_uids": [
      "<string>"
    ],
    "followers": [
      "<string>"
    ],
    "friendly_id": "<string>",
    "mode": "private",
    "priority": "low",
    "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",
    "submitted_from": "employee_portal",
    "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
​
assignee_admin

The admin user assigned to this request. Pass ?expand[]=field_name for full object.

​
assignee_admin_uid
string | null
deprecated

DEPRECATED: Use assignee_admin instead. The UID of assigned User.

​
assignee_inbox

The team inbox assigned to this request. Pass ?expand[]=field_name for full object.

​
assignee_inbox_uid
string | null
deprecated

DEPRECATED: Use assignee_inbox instead. The UID of assigned Team inbox.

​
associated_apps

Apps associated with this request. Pass ?expand[]=field_name for full objects.

​
associated_equipments

Equipment associated with this request. Pass ?expand[]=field_name for full objects.

​
attachments
object[]

Array containing the request attachments

​
description
string | null

The description of the Request

​
follower_uids
string[] | null
deprecated

DEPRECATED: Use followers instead. Array containing the followers UIDs.

​
followers

Users following this request. Pass ?expand[]=field_name for full objects.

​
priority
enum<string>
Available options:
low,
medium,
high,
urgent
​
requested_by

The user who requested this ticket. Pass ?expand[]=field_name for full object.

​
status
enum<string>
default:open

Request status

Available options:
open,
in_progress,
waiting,
resolved,
archived
​
tag_uids
string[] | null
deprecated

DEPRECATED: Use tags instead. Array containing the Request Tags UIDs.

​
tags

Tags associated with this request. Pass ?expand[]=field_name for full objects.

​
target

Service associated with this request. Pass ?expand[]=field_name for full object.

​
target_uid
string | null
deprecated

DEPRECATED: Use target instead. The UID of the associated Service.

​
title
string

The title of the Request

Response

200 - application/json

Successful

​
result
object