Close a pool
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.
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
POST https://toloka.dev/api/v1/pools/<pool_id>/close
Authorization: OAuth <OAuth token>
POST https://sandbox.toloka.dev/api/v1/pools/<pool_id>/close
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": "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"
}
}
|
Parameter |
Overview |
|
id |
string User ID. |
|
type |
string Type of operation: |
|
status |
string The status of the operation:
|
|
submitted |
string The UTC date and time the request was sent, in ISO 8601 format: |
|
started |
string The UTC date and time the operation started, in ISO 8601 format: |
|
finished |
string The UTC date and time the operation was completed, in ISO 8601 format: |
|
progress |
integer The percentage of the operation completed. |
|
parameters.pool_id |
string Pool ID. |