Move a pool to the archive

Attention

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

Moves a pool to the archive.

If a pool isn't in use, it can be moved to the archive. The pool must have the "closed" status.

A pool with rejected tasks can be archived 9 days after the last task was rejected. This period is required to review the results if the Toloker submits an appeal.

Exams with automatic acceptance by accuracy, where tasks with insufficient accuracy are rejected, can also be archived in 9 days.

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>/archive
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 pool is already archived, attempting to archive it again returns an empty response with status 204.

Contains information about the results of the operation.

{
"id" : "57068577e4b0bf7b07a0256f",
"type" : "POOL.ARCHIVE",
"status" : "SUCCESS",
"submitted" : "2016-04-07T16:06:15.902",
"started" : "2016-04-07T16:06:15.902",
"finished" : "2016-04-07T16:06:15.902",
"progress" : 100,
"parameters" : {
"pool_id" : "1"
}
}
ParameterOverview
idstring

Operation ID.
typestring

Type of operation: POOL.ARCHIVE — Archiving 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.

See also

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