Create approval request.

  • Published on Sep 3, 2025
  • 1 minute(s) read
Prev Next
Post
/v1/approval_requests

Create approval request

Security
API Key: bearerToken
Header parameter nameAuthentication

A JWT bearer token to be passed once authenticated.

Body parameters

Request to create an approval request.

Expand All
object

Request to create an approval request.

operation
string Required

Operation URL path, e.g. /crypto/v1/keys, /crypto/v1/groups/<id>.

method
string

Method for the operation: POST, PATCH, PUT, DELETE, or GET. Default is POST.

body
object
description
string

Optional comment about the approval request for the reviewer.

Responses
201

A newly created approval request.

Expand All
object
request_id
string (uuid)

UUID uniquely identifying this approval request.

requester
object (Entity)

An app, user, or plugin ID.

user
string (uuid)

The user ID of the user who created this entity, if this entity was created by a user.

created_at
integer (int64)

When this approval request was created.

acct_id
string (uuid)

The account ID of the account that this approval request belongs to.

group_id
string (uuid)

The group ID where this approval request belongs to.

operation
string

Operation URL path, e.g. /crypto/v1/keys, /crypto/v1/groups/<id>.

method
string

Method for the operation: POST, PATCH, PUT, DELETE, or GET. Default is POST.

body
object
approvers
Array of object (Entity)
object

An app, user, or plugin ID.

user
string (uuid)

The user ID of the user who created this entity, if this entity was created by a user.

denier
object (Entity)

An app, user, or plugin ID.

user
string (uuid)

The user ID of the user who created this entity, if this entity was created by a user.

denial_reason
string

Reason given by denier.

reviewers
Array of object (Entity)
object

An app, user, or plugin ID.

user
string (uuid)

The user ID of the user who created this entity, if this entity was created by a user.

status
string

Approval request status.

Valid values[ "PENDING", "APPROVED", "DENIED", "FAILED", "DENIED_OTHER", "PENDING_CHILD", "PENDING_OTHER" ]
subjects
Array of object (ApprovalSubject)
object

Identifies an object acted upon by an approval request.

workflow
string (uuid)

The ID of the workflow being acted upon.

description
string

Optional comment about the approval request for the reviewer.

expiry
integer (int64)

When this approval request expires.