Collections

PUT /collections/:uid

Endpoint

PUT /api/v2/collections/:uid

Parameters

Name Description type
uid required Collection uid string
collection[name] required Name string
collection[query] required Query string
collection[instructions] Instructions markdown_string

Request

Route

PUT /api/v2/collections/WT5Yi5Gk

Headers

Accept: application/json
Content-Type: application/json
Access-Token: 8675b3de694ed0642be36fcb6dbd2542a976ff6127517d886dc18d4b2650e88b$$O5JsOacxBHCnhyFltVCgWxK96gVUN5/GX8bkrE5wdbphxpyAvLF47v9mgw==--10fdBiO4pEPPG/z2--oMtPjRRqEgZK2CF/AAiZ5A==
Api-Key: iqkpEGEwz6R3GvS8

Body

{
  "collection": {
    "name": "Bar",
    "query": "foo, bar",
    "instructions": "Please label"
  }
}

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "collection": {
    "name": "Bar",
    "instructions": "Please label",
    "query": "foo, bar",
    "created_at": "2020-06-01T21:44:44.541Z",
    "updated_at": "2020-06-01T21:44:44.799Z",
    "uid": "WT5Yi5Gk",
    "team_uid": "o84Sw5nc",
    "scan_uids": [
      "8zh1Gi7a",
      "TyRpaDRX"
    ]
  }
}