Skip to main content
POST
Cancel an approval request

Authorizations

Authorization
string
header
required

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Scopes

documents:write

Create documents and edit the documents the user created.

Headers

Sajn-Version
enum<string>

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Available options:
2026-09,
2026-10
Sajn-Workspace
string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Path Parameters

id
string
required

The approval ID.

Body

application/json

Body

The body is of type object.

Response

An internal approval request for a document

An internal approval request for a document

id
string
required

Approval request ID

documentId
string
required

The document ID.

status
enum<string>
required

DRAFT while the document is a draft and the request isn't submitted, such as approvers a template added or a request whose document was withdrawn; PENDING while it waits for approvers; APPROVED once every stage approves; REJECTED after any approver rejects; CANCELLED only in the response to the cancel request and in the approval_request.cancelled event, because a cancelled request is deleted.

Available options:
DRAFT,
PENDING,
APPROVED,
REJECTED,
CANCELLED
autoSend
boolean
required

If true, sajn sends the document for signing when the request is approved. If false, the document waits for you to send it.

customMessage
string | null
required

The message included in the signing invitation when the document is sent

requestedBy
object
required

The user who submitted the request

approvers
object[]
required

The approvers, ordered by stage

createdAt
string<date-time>
required

When the approval was created.

updatedAt
string<date-time>
required

When the approval was last updated.