Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
Workspace

Patch workspace

Update your current workspace details. Note that this endpoint doesn't require any parameters. It will update the workspace based on the API key sent in the headers.

Requires one of the following scopes: workspaces:update, workspaces:all, all:update, all:all

patch/api/v2/workspaces/current

Request body

namestring

Name of the workspace

org_logo_urlstring nullable

URL to workspace logo

Example request

{
  "name": "My Workspace",
  "org_logo_url": "https://example.com/logo.png"
}

Response

The updated Workspace

idstring uuid required

Unique identifier for the workspace

timestamp_createdstring date-time required

Timestamp when the workspace was created

timestamp_updatedstring date-time required

Timestamp when the workspace was last updated

scheduled_for_removal_atstring date-time nullable

Timestamp when this workspace is scheduled to be removed

ownerstring uuid required

User ID of the workspace owner

namestring required

Name of the workspace

plan_idstring nullable

Plan ID for workspace

plan_id_bundlestring nullable

Plan ID for workspace bundle

add_unsub_to_blockboolean nullable

Whether to add unsubscribes to block list

default_opportunity_valuenumber nullable

Default value for opportunities

plan_id_leadfinderstring nullable

Plan ID for leadfinder

org_logo_urlstring nullable

URL to workspace logo

org_client_domainstring nullable

The domain for the white label agency mode

plan_id_crmstring nullable

Plan ID for CRM

plan_id_website_visitorstring nullable

Plan ID for website visitor tracking

plan_id_inbox_placementstring nullable

Plan ID for inbox placement

Example response

{
  "id": "019f94cd-83ea-79bb-bdb3-0de8091ad703",
  "timestamp_created": "2026-07-24T15:45:24.458Z",
  "timestamp_updated": "2026-07-24T15:45:24.458Z",
  "scheduled_for_removal_at": "2026-07-24T15:45:24.458Z",
  "owner": "019f94cd-83ea-79bb-bdb3-0de9ebb80f87",
  "name": "My Workspace",
  "plan_id": "pid_hg_v1",
  "plan_id_bundle": "pid_bundle_scale_v1",
  "default_opportunity_value": 250,
  "plan_id_leadfinder": "pid_lf_ls_v1",
  "plan_id_verification": {
    "quantity": 5,
    "product_id": "pid_verify_v1_monthly",
    "timestamp_updated": "2024-07-22T05:56:58.667Z"
  },
  "org_logo_url": "https://example.com/logo.png",
  "org_client_domain": "example.com",
  "plan_id_crm": "pid_crm_v1",
  "plan_id_website_visitor": "pid_wvw_v1",
  "plan_id_inbox_placement": "pid_ip_v1"
}