Move a pool to the archive

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

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.

Request

POST https://toloka.yandex.com/api/v1/pools/<pool_id>/archive
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 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"
  }
}
Parameter Overview
id

string

User ID.

type

string

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.
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.ARCHIVE — Archiving 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.