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",
    "323e4567-e89b-12d3-a456-426614174002"
  ],
  "status": "APPROVED"
}'
{
  "success": [
    "123e4567-e89b-12d3-a456-426614174000",
    "223e4567-e89b-12d3-a456-426614174001"
  ],
  "failed": []
}

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 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 Status of the document. Valid options: DRAFT, REVIEW, APPROVED, ARCHIVED.

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

"APPROVED"

Response

Bulk status update request processed

Response containing success and failure information for status updates

​
success
string<uuid>[]
required

Array of document IDs that were successfully updated

Example:
["123e4567-e89b-12d3-a456-426614174000"]
​
failed
object[]
required

Array of document IDs that failed with reasons