API ReferenceProjectsPauses

Update pause

Partially update a pause entry by ID.

Path parameters

idstringRequired
project_pkintegerRequired
user_pkintegerRequired

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
reasonenumOptional

Reason for pausing

  • MANUAL - Manual
  • BEHAVIOR_BASED - Behavior-based
  • ANNOTATOR_EVALUATION - Annotator evaluation
  • ANNOTATION_LIMIT - Annotation limit
  • CUSTOM_SCRIPT - Custom script
Allowed values:
verbose_reasonstringOptional
Detailed description of why the project is paused, will be readable by paused annotators

Response

created_atdatetime
Timestamp when this pause record was created
idinteger
paused_byobject
A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
reasonenum

Reason for pausing

  • MANUAL - Manual
  • BEHAVIOR_BASED - Behavior-based
  • ANNOTATOR_EVALUATION - Annotator evaluation
  • ANNOTATION_LIMIT - Annotation limit
  • CUSTOM_SCRIPT - Custom script
Allowed values:
updated_atdatetime
Timestamp when this pause record was last updated
deleted_atdatetime or null

Timestamp when this pause record was soft-deleted

deleted_byinteger or null

User who soft-deleted this pause record

projectinteger or null
Related project for which the pause is set
userinteger or null
User who is paused
verbose_reasonstring or null
Detailed description of why the project is paused, will be readable by paused annotators