Skip to content
Optiwork API Docs

Set the approvals on a file

POST
/drives/{drive}/nodes/{node}/approvals/sync
curl --request POST \
  --url https://work.optidata.cloud/api/drives/1/nodes/300754/approvals/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "approvals": [ { "id": 1, "requested_user_email": "john.roe@acme.example", "requester_user_note": "Please confirm the figures on page 3.", "is_rejection_reason_required": true, "expires_at": "2026-09-30", "edit_mode": "blocked" } ] }'

Declares the complete set of approval requests for the file: entries with an existing id are updated, new ones are created, and anything left out is removed. Address each approver either by requested_user_id or by requested_user_email.

expires_at is interpreted as a date and stored at the end of that day. Requires view on the node; approvals exist on files only.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
drive
required
integer format: int64

Numeric id of the drive. Read it from GET /drives/config.json.

node
required
integer format: int64

Numeric id of the node (file or folder).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
approvals
required
Array<object>
object
id
required

Id of an existing approval, or a client-side id for a new one.

integer format: int64
requested_user_id

Required unless requested_user_email is given.

integer | null format: int64
requested_user_email

Required unless requested_user_id is given.

string | null format: email
requester_user_note
string | null
<= 1000 characters
is_download_allowed
boolean | null
is_rejection_reason_required

When true, a rejection must carry a reason.

boolean | null
expires_at
string | null format: date
edit_mode
One of:

Whether the file stays editable while the approval is open (released) or is frozen until it is decided (blocked).

string
Allowed values: blocked released
Examples
Examplerequest
{
  "approvals": [
    {
      "id": 1,
      "requested_user_email": "john.roe@acme.example",
      "requester_user_note": "Please confirm the figures on page 3.",
      "is_rejection_reason_required": true,
      "expires_at": "2026-09-30",
      "edit_mode": "blocked"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200”

The resulting approvals.

Media typeapplication/json
Array<object>

A request asking a specific user to approve or reject a file. Folders cannot carry approvals.

object
id
integer format: int64
node_id
integer format: int64
requester_user_id
integer format: int64
requested_user_id
integer | null format: int64
requested_user_email

Set when the approver is addressed by e-mail rather than by id.

string | null format: email
status
string
Allowed values: pending approved rejected
requester_user_note
string | null
<= 1000 characters
comment

Optional note left by the approver.

string | null
<= 255 characters
rejection_reason
string | null
<= 255 characters
is_download_allowed
boolean | null
is_rejection_reason_required
boolean | null
edit_mode
One of:

Whether the file stays editable while the approval is open (released) or is frozen until it is decided (blocked).

string
Allowed values: blocked released
expires_at
string | null format: date-time
created_at
string format: date-time
updated_at
string format: date-time
requesterUser
One of:

Compact representation of a user, embedded in other payloads.

object
id
integer format: int64
uuid

Tenant-wide identifier of the user. Use this, not id, on account endpoints.

string format: uuid
name
string
email
string format: email
status

Present where the payload includes it (for example audit entries).

string
Allowed values: active inactive blocked
deleted_at
string | null format: date-time
avatar_url
string | null format: uri
full_name
string
requestedUser
One of:

Compact representation of a user, embedded in other payloads.

object
id
integer format: int64
uuid

Tenant-wide identifier of the user. Use this, not id, on account endpoints.

string format: uuid
name
string
email
string format: email
status

Present where the payload includes it (for example audit entries).

string
Allowed values: active inactive blocked
deleted_at
string | null format: date-time
avatar_url
string | null format: uri
full_name
string
Example
[
  {
    "status": "pending",
    "edit_mode": "blocked",
    "requesterUser": {
      "id": 15,
      "uuid": "9c1f0e2a-4d31-4d8a-8c1a-1f0b6b1f9a10",
      "name": "Jane Doe",
      "email": "jane.doe@acme.example",
      "status": "active"
    },
    "requestedUser": {
      "id": 15,
      "uuid": "9c1f0e2a-4d31-4d8a-8c1a-1f0b6b1f9a10",
      "name": "Jane Doe",
      "email": "jane.doe@acme.example",
      "status": "active"
    }
  }
]

401

Section titled “401”

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The caller lacks the permission level the operation requires.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Exampledenied
{
  "message": "This action is unauthorized."
}

404

Section titled “404”

The resource does not exist, or does not belong to the given drive.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplemissing
{
  "message": "No query results for model [App\\Models\\Node] 99999999"
}

422

Section titled “422”

The request body or query string failed validation.

Media typeapplication/json
object
message
required

The first validation message.

string
errors
required

Validation messages keyed by field name.

object
key
additional properties
Array<string>
Examples
Exampleinvalid
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

429

Section titled “429”

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
  "message": "Too Many Attempts."
}