Close a pool

  1. Request
  2. Path parameters
  3. Headers
  4. Response

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.yandex.com/api/v1/pools/<pool_id>/close
Authorization: OAuth <OAuth token>

Path parameters

Parameter Overview
pool_id Pool ID.
Parameter Overview
pool_id Pool ID.

Headers

Title Overview
Authorization A token for account authorization. Add OAuth as a prefix.
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: 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.
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.