INinstantly
Workspace

Set the agency domain for the workspace

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

post/api/v2/workspaces/current/whitelabel-domain

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/workspaces/current/whitelabel-domain
  • Auth
    HTTP bearer

Request body

domainstring required

The agency domain to set for the workspace

Example request

{
  "domain": "agency.example.com"
}

Response

The requested 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 of a legacy CRM subscription. The CRM plan is no longer sold; CRM is included in Hyper Growth and higher plans.

plan_id_website_visitorstring nullable

Plan ID for website visitor tracking

plan_id_inbox_placementstring nullable

Plan ID for inbox placement

Example response

{
  "id": "01a19e6f-50a8-7332-8ede-633af24bd039",
  "timestamp_created": "2026-11-02T22:44:17.704Z",
  "timestamp_updated": "2026-11-02T22:44:17.704Z",
  "scheduled_for_removal_at": "2026-11-02T22:44:17.704Z",
  "owner": "01a19e6f-50a8-7332-8ede-633bd9de2e2e",
  "name": "My Workspace",
  "plan_id": "pid_hg_v1",
  "plan_id_bundle": "pid_bundle_scale_v2",
  "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_hg",
  "plan_id_website_visitor": "pid_wvw_v1",
  "plan_id_inbox_placement": "pid_ip_v1"
}

Changes

No recorded changes to this operation across all 6 revisions of this API.