---
title: "✨ Update pause"
method: PATCH
path: "/api/projects/{project_pk}/members/{user_pk}/pauses/{id}/"
tags: ["Pauses"]
---

# ✨ Update pause

`PATCH /api/projects/{project_pk}/members/{user_pk}/pauses/{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.

## Path parameters

- `id` integer, required
- `project_pk` integer, required
- `user_pk` integer, required

## Request body

- PatchedPauseRequest — 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
  - `reason` 'MANUAL' | 'BEHAVIOR_BASED' | 'ANNOTATOR_EVALUATION' | 'ANNOTATION_LIMIT' | 'CUSTOM_SCRIPT' — * `MANUAL` - Manual * `BEHAVIOR_BASED` - Behavior-based * `ANNOTATOR_EVALUATION` - Annotator evaluation * `ANNOTATION_LIMIT` - Annotation limit * `CUSTOM_SCRIPT` - Custom script
  - `verbose_reason` string, nullable — Detailed description of why the project is paused, will be readable by paused annotators

## Response `200`

- Pause — 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
  - `created_at` string, date-time, required — Timestamp when this pause record was created
  - `deleted_at` string, date-time, nullable, required — Timestamp when this pause record was soft-deleted
  - `deleted_by` integer, nullable, required — User who soft-deleted this pause record
  - `id` integer, required
  - `paused_by` UserSimple, required — 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
    - `avatar` string, nullable, required
    - `email` string, email
    - `first_name` string
    - `id` integer, required
    - `last_name` string
    - `username` string, required
  - `project` integer, nullable, required — Related project for which the pause is set
  - `reason` 'MANUAL' | 'BEHAVIOR_BASED' | 'ANNOTATOR_EVALUATION' | 'ANNOTATION_LIMIT' | 'CUSTOM_SCRIPT', required — * `MANUAL` - Manual * `BEHAVIOR_BASED` - Behavior-based * `ANNOTATOR_EVALUATION` - Annotator evaluation * `ANNOTATION_LIMIT` - Annotation limit * `CUSTOM_SCRIPT` - Custom script
  - `updated_at` string, date-time, required — Timestamp when this pause record was last updated
  - `user` integer, nullable, required — User who is paused
  - `verbose_reason` string, nullable — Detailed description of why the project is paused, will be readable by paused annotators

## Changes

> 97 revisions in range; 1 not diffed.

- **2026-07-08** `b5f055b9d45b` — 1 breaking
  - the response property `paused_by/allOf[#/components/schemas/UserSimple]/avatar` became nullable for the status `200`
- **2026-07-06** `c2893748a8d3` — 1 breaking
  - for the `path` request parameter `id`, the type/format was changed from `string`/`` to `integer`/``

[Change history](https://skmtc.dev/humansignal/apis/label-studio-api/changes/api/projects/:project_pk/members/:user_pk/pauses/:id/patch.md)

---

[API](https://skmtc.dev/humansignal/apis/label-studio-api.md) · [All operations](https://skmtc.dev/humansignal/apis/label-studio-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/humansignal/label-studio-api/revisions/b589624c66c3/schema)