✨ Update pause | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Partially update a pause entry by ID.

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Partially update a pause entry by ID.

Authentication

Authorizationstring

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idstringRequired

project_pkintegerRequired

user_pkintegerRequired

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

Reason for pausing * `MANUAL` - Manual * `BEHAVIOR_BASED` - Behavior-based * `ANNOTATOR_EVALUATION` - Annotator evaluation * `ANNOTATION_LIMIT` - Annotation limit * `CUSTOM_SCRIPT` - Custom script

Allowed values:

verbose_reasonstring or nullOptional

Detailed description of why the project is paused, will be readable by paused annotators

Response

created_atdatetime

Timestamp when this pause record was created

deleted_atdatetime or null

Timestamp when this pause record was soft-deleted

deleted_byinteger or null

User who soft-deleted this pause record

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

projectinteger or null

Related project for which the pause is set

reasonenum

Reason for pausing

MANUAL - Manual
BEHAVIOR_BASED - Behavior-based
ANNOTATOR_EVALUATION - Annotator evaluation
ANNOTATION_LIMIT - Annotation limit
CUSTOM_SCRIPT - Custom script

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

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

1	curl -X PATCH http://localhost:8000/api/projects/1/members/1/pauses/id/ \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"deleted_at": "2024-01-15T09:30:00Z",
4	"deleted_by": 1,
5	"id": 1,
6	"paused_by": {
7	"avatar": "string",
8	"id": 1,
9	"email": "string",
10	"first_name": "string",
11	"last_name": "string"
12	},
13	"project": 1,
14	"reason": "MANUAL",
15	"updated_at": "2024-01-15T09:30:00Z",
16	"user": 1,
17	"verbose_reason": "string"
18	}