Skip to main content
PATCH
Update workspace

Authorizations

Authorization
string
header
required

Your Postbreeze API key

Path Parameters

workspaceId
string
required

Prefixed cuid of the workspace to update.

Example:

"ws_01HZX5T2K9Q3RB6N6JZP3RYV0M"

Body

application/json
name
string
Required string length: 1 - 80
timezone
string

IANA timezone.

timeFormat
enum<string>
Available options:
H24,
H12
naturalPostingTimes
boolean

Natural posting times: publish scheduled posts with a random ±4 minute offset around the slot time.

threadsAutoRepostDefaults
object

"Remember for next time" default for the Threads Auto-Repost dialog (threadsAutoRepostSchema shape), or null to clear.

threadsAutoPlugDefaults
object

"Remember for next time" default for the Threads Auto-Plug dialog (threadsAutoPlugSchema shape), or null to clear.

brandColor
string

Brand hex color used in the dashboard chrome.

logoUrl
string | null

Workspace logo URL, or null to clear.

Response

The updated workspace.

id
string

Prefixed cuid identifier.

name
string

Display name.

slug
string

Globally unique URL slug.

ownerUserId
string

User id of the workspace owner.

timezone
string

IANA timezone the workspace is scheduled against.

timeFormat
enum<string>

Hour format used in the UI.

Available options:
H24,
H12
brandColor
string | null

Brand hex color used in the dashboard chrome. null when unset.

logoUrl
string | null

Workspace logo URL. null when unset.

deletedAt
string<date-time> | null

Set when the workspace has been soft-deleted; otherwise null.

createdAt
string<date-time>
updatedAt
string<date-time>