Skip to main content
PUT
Update current workspace

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

syncs
Syncs · object[]

Recurring sync schedules for workspace domains.

name
string

Display name for the workspace.

Required string length: 1 - 255
Pattern: ^[^<>]*$
allowedEmailDomains
string[]

Email domains allowed to join this workspace.

logoBase64
string | null

Workspace logo as a base64-encoded image. Pass null to remove.

metadata
Metadata · object

Workspace onboarding metadata.

chromeExtensionMasterAgentUuid
string<uuid> | null

Agent the Chrome extension uses as the default. Pass null to clear.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
chromeExtensionAvailableAgentUuids
string[] | null

Agents the Chrome extension may offer. Pass null to clear.

defaultRoleUuid
string<uuid> | null

Role assigned to new workspace members. Pass null to use admin.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
allowedLoginProviders
enum<string>[] | null

Login providers members may use. Pass null to allow all.

Available options:
email,
google-oauth2,
azuread,
okta

Response

Update current workspace

workspace
object
required