Skip to main content
POST
/
v1
/
requests
/
{request_uid}
/
approvals
Request an approval
curl --request POST \
  --url https://api.siit.io/v1/requests/{request_uid}/approvals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body_markdown": "<string>",
  "approver_uids": "<array>",
  "add_to_followers": false,
  "body_text": "<string>",
  "sent_by": "<string>"
}
'
{
  "result": {
    "uid": "<string>",
    "approver_uids": [
      "<string>"
    ],
    "request_approvals": [
      "<string>"
    ],
    "body_text": "<string>",
    "body_markdown": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "event_type": "requested_approval",
    "sender_type": "user",
    "sent_by": "<string>",
    "sent_by_uid": "<string>",
    "submitted_from": "public_api"
  }
}

​
Usage

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
request_uid
string
required

The UID (or friendly_id) of the request

Body

application/json
​
body_markdown
string
required

Content of the approval request as markdown. Takes precedence over body_text when both are provided.

​
approver_uids
array | null

UID of one or more users

​
add_to_followers
boolean
default:false

Whether approvers should be added to followers of the request

​
body_text
string | null
deprecated

please use "body_markdown" instead

​
sent_by
string | null

Optional UID of another admin user that should be considered authoring approval request

Response

Created

​
result
object