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

Headers

Accept: application/json
Content-Type: application/json
Access-Token: 9bb74d904d025736696ac4fa43314384f513b83e35c6c0a5155e0067701a73b2$$qCN+d+NeUE/BP1nnF5gpGzHAvaRuYTgePq2XUnFBOuNX5erMQ8n9TFZybA==--vF2iwBG24QW/exvU--2VyN5DILTQQMBBMLOz9DhA==
Api-Key: 8zGTwsenwmFfy9Ga

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-11-20T21:13:16.152Z",
    "updated_at": "2019-11-20T21:13:16.548Z",
    "uid": "pWuzN8mB",
    "team_uid": "Y4k2ed8m",
    "scan_uids": [
      "fEp7Vtd1",
      "trZERoM7"
    ]
  }
}