Close a pool

Attention

The toloka.yandex.com domain will be disabled starting July 1, 2023. Please use the toloka.dev domain for API requests.

Closes a pool.

To stop assigning tasks to Tolokers, close the pool.

When you send requests, an operation is created. To track the progress of the operation, send a request to the /operations resource.

Request

Tip

Try our new API reference: more parameter details, request/response examples, and code samples in various programming languages, including the Toloka-Kit usage samples.

Production version
Sandbox
POST https://toloka.dev/api/v1/pools/<pool_id>/close
Authorization: OAuth <OAuth token>

Path parameters

ParameterOverview
pool_idPool ID.

Headers

TitleOverview
AuthorizationA 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": "fadfe3jk-fdafue2-fda32890-fdafdi23",
"type": "POOL.CLOSE",
"status": "PENDING",
"submitted": "2015-22-12T14:18:35",
"started" : "2016-04-07T16:06:15.902",
"finished" : "2016-04-07T16:06:15.902",
"progress" : 100,
"parameters": {
"pool_id": "21"
}
}
ParameterOverview
idstring

Operation ID.
typestring

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.
submittedstring

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

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

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

The percentage of the operation completed.
parameters.pool_idstring

Pool ID.
Contact support
Toloka API
OverviewAccessing the APIRate limiting
Quick start
Reference
Project
Pools
Training
Subscriptions to events
Toloker selection
Ways to upload tasks
Tasks
Task suites
Tracking operations
Getting responses
Checking completed tasks
Bonuses
Messages for Tolokers
Various parameters
Libraries