Update a document assignment

patch

https://api.operations1.app/tenants/{tenantId}/order-document-assignments/{orderDocumentAssignmentId}

Path Params

tenantId

string

required

length between 1 and 100

Consists of the subdomain. The tenantId for https://company.operations1.app/ is company.

orderDocumentAssignmentId

integer

required

1 to 9007199254740991

Body Params

quantity

integer

≥ 1

position

integer

≥ 0

assignedUserIds

array of integers

assignedUserIds

assignedGroupIds

array of integers

assignedGroupIds

useLatestDocument

boolean

Defaults to true

reportName

length ≥ 1

variables

object

Variable values that apply to this document assignment's reports only, keyed by variable key.

variablesById

array of objects

Variable values that apply to this document assignment's reports only, addressed by variable id. Cannot be combined with variables.

variablesById

Headers

accept-version

required

Defines the API version. Using a date is recommended for stability. Avoid using latest in production, as it refers to the most up-to-date functionality, which may include breaking changes. For more details, see our article on versioning.

Specifies the API version in date format (e.g., "2024-01-01"). Allowed values include 2025-04-21, 2026-10-19

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Default Response

400Invalid request or variable value not valid for the type of the variable

401This error ist returned if authentication of the request was not successful. For more information read our article about authentication.

403This error is returned if you do not have the necessary permissions for the endpoint.

404Variable or order document assignment not found

429This error is returned if your request was not executed due to rate limit. For more information read our article about rate limiting.

defaultGeneral errors