MEmetabase
/api/collection

PUT /api/collection/{id}

Changed on

Modify an existing Collection, including archiving or unarchiving it, or moving it.

put/api/collection/{id}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Path parameters

idinteger required

value must be an integer greater than zero.

Request body

archivedboolean nullable

value must be a valid boolean string ('true' or 'false').

authority_level'official' nullable
descriptionstring nullable

value must be a non-blank string.

namestring nullable

value must be a non-blank string.

parent_idinteger nullable

value must be an integer greater than zero.

Response

Successful response

Changes

  • 2e178f5a7934Revision changes
    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • warning

      removed the request property

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      the request property became optional

    • info

      added the media type application/json for the response with the status

  • 78297d193ca4Revision changes
    • info

      api operation id put-api-collection-id was added