Honeycluster Docs – Create a watchlist

accounts

Create a watchlist

post

/watchlists

operationId: account-createWatchlist

Creates a new watchlist under the caller's ownership. Slug must be globally unique.

Authorizations

Name	Location	Details
`BearerAuth`	Authorization header · bearer	JWT issued by the Honeycluster auth service for the `indexer` audience. Present as `Authorization: Bearer <token>`.

Request Body

application/json

required

Field	Type	Default	Description
`slug` required	string		URL-safe unique identifier.
`name` required	string		Display name.
`description`	string
`isPublic`	boolean	`false`
`ownerId`	string

Example

Json

{
  "slug": "string",
  "name": "string",
  "description": "string",
  "isPublic": false,
  "ownerId": "string"
}

Responses

200

application/json

Successful response

Field	Type	Description
`id`	string	Auto-generated UUID primary key.
`slug`	string	URL-safe unique identifier for the watchlist.
`name`	string	Human-readable display name.
`description`	object
`ownerId`	object
`isPublic`	boolean	True when the watchlist is visible to unauthenticated clients.
`createdAt`	integer	Record creation timestamp, Unix-seconds.
`updatedAt`	integer	Record update timestamp, Unix-seconds.

Example

Json

{
  "id": "00000000-0000-0000-0000-000000000000",
  "slug": "string",
  "name": "string",
  "description": "string",
  "ownerId": "string",
  "isPublic": false,
  "createdAt": 1745798400,
  "updatedAt": 1745798400
}

400

application/json

Invalid input data

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401

application/json

Authorization not provided

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403

application/json

Insufficient access

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

500

application/json

Internal server error

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}