Skip to main content
PATCH
Update Sink

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

Sink ID

Body

application/json
name
string

Sink name

Required string length: 1 - 255
description
string | null

Optional description

color
enum<string>

Display color

Available options:
neutral,
blue,
green,
yellow,
orange,
red,
purple,
pink
is_public
boolean

Whether the sink is publicly accessible

public_slug
string | null

Public URL slug

Required string length: 1 - 255
Pattern: ^[a-z0-9-]+$

Response

A sink collects and organizes items from external sources

A sink collects and organizes items from external sources

id
string<uuid>

Unique identifier

name
string

Sink name

Required string length: 1 - 255
description
string | null

Optional description

color
enum<string>

Display color

Available options:
neutral,
blue,
green,
yellow,
orange,
red,
purple,
pink
is_public
boolean

Whether the sink is publicly accessible

public_slug
string | null

Public URL slug

Required string length: 1 - 255
Pattern: ^[a-z0-9-]+$
secret
string

Secret key for adding items to this sink

workspace_id
string<uuid>

Workspace ID

owner_id
string<uuid>

Owner user ID

created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp