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/8ztcx7yZ

Headers

Accept: application/json
Content-Type: application/json
Access-Token: f7b161511b8a8162cf032e8e0598139b880cb7ef4b318e0f1295848c56b2c43e$$yntA5IaS3n9m8OibIxhgguuKnvhnsz267zFSIs9xJXjB2EPcFvQBGD//yQ==--H7Q/tyjWu6s4goO9--4CvVqcq0vu/L5Vp7MlFFng==
Api-Key: 1XyE9vzXrWWcGckV

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-01-15T19:56:03.568Z",
    "updated_at": "2020-01-15T19:56:03.839Z",
    "uid": "8ztcx7yZ",
    "team_uid": "9TTJJfEd",
    "scan_uids": [
      "pUr1WgSW",
      "gf8HCDan"
    ]
  }
}