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/4zvVvapX

Headers

Accept: application/json
Content-Type: application/json
Access-Token: ef281599e9e5041a2e2083c1d72d71461fc9ff0efd8594b2f6f4cb2496e4f22d$$mjf7aonreWLaC/DGR4pO94LTHUli78PTXjNJbB2cb7e91c669Zz986FvTQ==--qiqAhOvWtaJyvPLn--5O5uGWDGnS6LSFrg9kgKUQ==
Api-Key: DcbB5VeCktGPzK1j

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-06-18T22:04:30.938Z",
    "updated_at": "2019-06-18T22:04:31.311Z",
    "uid": "4zvVvapX",
    "team_uid": "zjXMsUAZ",
    "scan_uids": [
      "zV2m6i9t",
      "udqjfEQ4"
    ]
  }
}