Toloka documentation

Close a pool for editing

Warning

We recommend that you use the toloka.dev domain for API requests. The toloka.yandex.com domain is still supported but it will be deprecated soon.

Closes a pool for editing.

To make changes to a pool, close it before editing.

Note

If you don't open the pool manually after editing, it opens automatically in 15 minutes. In this case, no checks are performed that can block the pool's opening.

Request

POST https://toloka.dev/api/v1/pools/<pool_id>/close-for-update
Authorization: OAuth <OAuth token>
POST https://sandbox.toloka.dev/api/v1/pools/<pool_id>/close-for-update
Authorization: OAuth <OAuth token>

Path parameters

Parameter Overview
pool_id Pool ID.

Headers

Title Overview
Authorization A token for account authorization. Add OAuth as a prefix.

Response

Note

If the current pool status is the same as the  requested status, an empty response with status 204 is returned.

{
  "id": "019587fd-b536-49f8-b6dc-01ffc25f8594",
  "type": "POOL.CLOSE",
  "status": "PENDING",
  "submitted": "2021-11-24T07:47:50.120",
  "started" : "2021-11-24T07:47:50.120",
  "finished" : "2021-11-24T07:47:50.120",
  "progress" : 100,
  "parameters": {
    "pool_id": "21"
  }
}

Parameter

Overview

id

string

User ID.

type

string

Type of operation: POOL.CLOSE — Closing a pool.

status

string

The status of the operation:

  • PENDING — Not started yet.
  • RUNNING — In progress.
  • SUCCESS — Completed successfully.
  • FAIL — Not completed.

submitted

string

The UTC date and time the request was sent, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

started

string

The UTC date and time the operation started, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

finished

string The UTC date and time the operation was completed, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

progress

integer The percentage of the operation completed.

parameters.pool_id

string Pool ID.