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/DQUFAfR2

Headers

Accept: application/json
Content-Type: application/json
Access-Token: 607f36c1fac39e8dfee710e30f22ebfd1fb4fb45fa9166a775f0865974625957$$Qnr3Ce/+S6XnPFJdKn7/ocS6oIAiDCNyx6yd0NjIm4tsrmWpTnZQp3X+nA==--eYa04kIoq3VxozLW--/xd1ruaqkHUekoLe6Pn5XQ==
Api-Key: J3bbAmmbLcFvthCd

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": "2019-08-05T22:48:29.448Z",
    "updated_at": "2019-08-05T22:48:29.976Z",
    "uid": "DQUFAfR2",
    "team_uid": "WN2FqDkQ",
    "scan_uids": [
      "YoPFo8u1",
      "uhLAmdev"
    ]
  }
}