Collections

Update a collection

post/collections.update

Request body

idstring uuid required
namestring
permission'read' | 'read_write'
descriptionstring
colorstring

Example request

{
  "name": "Human Resources",
  "color": "#123123"
}

Response

OK

Example response

{
  "data": {
    "name": "Human Resources",
    "index": "P",
    "color": "#123123"
  }
}

Changes

Changed in 2 of the 6 revisions of this API.13

    • added the non-success response with the status 429

      response-non-success-status-added

    • added the optional property data to the response with the 400 status

      response-optional-property-added

    • added the optional property data to the response with the 401 status

      response-optional-property-added

    • added the optional property data to the response with the 403 status

      response-optional-property-added

    • added the optional property data to the response with the 404 status

      response-optional-property-added

    • added the optional property message to the response with the 400 status

      response-optional-property-added

    • added the optional property message to the response with the 401 status

      response-optional-property-added

    • added the optional property message to the response with the 403 status

      response-optional-property-added

    • added the optional property message to the response with the 404 status

      response-optional-property-added

    • added the optional property status to the response with the 400 status

      response-optional-property-added

    • added the optional property status to the response with the 401 status

      response-optional-property-added

    • added the optional property status to the response with the 403 status

      response-optional-property-added

    • added the optional property status to the response with the 404 status

      response-optional-property-added