Update collection

PATCH

/api/v1/collections/{id}

const url = 'https://example.com/api/v1/collections/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","description":"example","color":"#FF5733","emoji":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://example.com/api/v1/collections/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "color": "#FF5733", "emoji": "example" }'

Authorizations

bearer

Parameters

Path Parameters

required

string

Collection UUID

Request Body^required

application/json

object

name

Collection name

string

>= 1 characters <= 100 characters

description

Description

string

<= 500 characters

color

Hex color (e.g. #FF5733)

string

Example

#FF5733

emoji

Emoji

string

<= 10 characters

Responses

200

Collection updated

Update collection

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Example

Responses

200

Request Body^required