Skip to main content
POST
/
v0
/
documents
/
status
Bulk update status of multiple document versions
curl --request POST \
  --url https://api.avidoai.com/v0/documents/status \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "documentIds": [
    "123e4567-e89b-12d3-a456-426614174000",
    "223e4567-e89b-12d3-a456-426614174001"
  ],
  "status": "APPROVED"
}
'
{
  "message": "Invalid request data",
  "issues": [
    {
      "code": "invalid_string",
      "message": "Invalid UUID",
      "path": [
        "id"
      ]
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Request body for bulk updating status of multiple document versions

​
documentIds
string<uuid>[]
required

Array of document IDs to update status. Maximum 100 documents per request.

Minimum array length: 1
Example:
[
  "123e4567-e89b-12d3-a456-426614174000",
  "223e4567-e89b-12d3-a456-426614174001"
]
​
status
enum<string>
required

The new status to apply to all specified documents

Available options:
DRAFT,
REVIEW,
APPROVED,
ARCHIVED
Example:

"APPROVED"

Response

Bulk status update request processed