AMampache
Collections

Edit a collection

Changed on

Only the fields you send are changed. Send an empty object_type to un-pin a collection back to mixed; pinning is refused while the collection still holds a different type.

patch/collections/{collection_id}

Request

  • Base URL
    https://develop.ampache.dev/rest/8/json
  • URL
    https://develop.ampache.dev/rest/8/json/collections/{collection_id}
  • Auth
    • HTTP bearer
    • or API key in header auth
    • or API key in query parameter auth

Path parameters

collection_idstring required

Query parameters

namestring
type'public' | 'private'
object_typestring
collaboratestring

Request body

namestring
type'public' | 'private'
object_typestring
collaboratestring

Response

The collection that was edited

Changes

  • f37b545b95d7Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • d57745813d53Revision changes
    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)