Update a workspace

Update a workspace by ID or slug.

Authorizations

Authorization

string

headerrequired

Default authentication mechanism

Path Parameters

idOrSlug

string

required

The ID or slug of the workspace to update.

Body

application/json

name

string

Required string length: 1 - 32

slug

string

Required string length: 3 - 48

logo

string

Response

200 - application/json

id

string

required

The unique ID of the workspace.

name

string

required

The name of the workspace.

slug

string

required

The slug of the workspace.

logo

string | null

required

The logo of the workspace.

inviteCode

string | null

required

The invite code of the workspace.

plan

enum<string>

required

The plan of the workspace.

Available options:

free,

pro,

business,

business plus,

business extra,

business max,

enterprise

stripeId

string | null

required

The Stripe ID of the workspace.

billingCycleStart

number

required

The date and time when the billing cycle starts for the workspace.

paymentFailedAt

string | null

required

The date and time when the payment failed for the workspace.

stripeConnectId

string | null

required

[BETA – Dub Conversions]: The Stripe Connect ID of the workspace.

payoutMethodId

string | null

required

[BETA – Dub Partners]: The ID of the payment method for partner payouts.

usage

number

required

The usage of the workspace.

usageLimit

number

required

The usage limit of the workspace.

linksUsage

number

required

The links usage of the workspace.

linksLimit

number

required

The links limit of the workspace.

salesUsage

number

required

The dollar amount of tracked revenue in the current billing cycle (in cents).

salesLimit

number

required

The limit of tracked revenue in the current billing cycle (in cents).

domainsLimit

number

required

The domains limit of the workspace.

tagsLimit

number

required

The tags limit of the workspace.

usersLimit

number

required

The users limit of the workspace.

aiUsage

number

required

The AI usage of the workspace.

aiLimit

number

required

The AI limit of the workspace.

conversionEnabled

boolean

required

Whether the workspace has conversion tracking enabled (d.to/conversions).

dotLinkClaimed

boolean

required

Whether the workspace has claimed a free .link domain. (dub.link/free)

partnersEnabled

boolean

required

Whether the workspace has Dub Partners enabled.

createdAt

string

required

The date and time when the workspace was created.

users

object[]

required

The role of the authenticated user in the workspace.

Show child attributes

users.role

enum<string>

required

The role of the authenticated user in the workspace.

Available options:

owner,

member

domains

object[]

required

The domains of the workspace.

Show child attributes

domains.slug

string

required

The domain name.

domains.primary

boolean

default: falserequired

Whether the domain is the primary domain for the workspace.

domains.verified

boolean

default: falserequired

Whether the domain is verified.

flags

object

The feature flags of the workspace, indicating which features are enabled.

Show child attributes

flags.{key}

boolean