Annotation

Assign annotation

Change assignees of one or more annotations. The annotations are reassigned together: if any of them can't be reassigned, none of them is changed.

<Callout type="info"> `admin` and `organization_group_admin` user roles can assign to arbitrary set of users. The rest of the roles can only swap themselves for a different user (without changing the others). </Callout>

post/api/v1/annotations/assign

Request

Base URL
https://example.rossum.app
Auth
HTTP bearer
TypeScript
https://skmtc.dev/rossum/apis/rossum-api/docs/api/v1/annotations/assign/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

annotationsstring[] required

List of annotations to change the assignees of. An annotation listed more than once is reassigned only once.

assigneesstring[] required

List of users to be added as assignees.

note_contentstring

Content of the note that will be added to the workflow activity of action reassign (only applicable for annotation in in_workflow state).

Example request

{
  "annotations": [
    "https://example.rossum.app/api/v1/annotations/319668"
  ],
  "assignees": [
    "https://example.rossum.app/api/v1/users/1",
    "https://example.rossum.app/api/v1/users/2"
  ]
}

Response

No Content

Changes

No recorded changes to this operation across all 14 revisions of this API.