POST
/
workspaces

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

properties
enum<string>[]

Select the workspace properties that should be returned

Available options:
accountId,
name,
workspaceUrl,
templateId,
startDate,
targetEndDate,
actualEndDate,
projectAge,
taskProgress,
lastContactView,
totalViews,
totalActions,
totalTimeSpent,
contactsCount,
account.name,
account.website,
account.ownerId,
account.logo,
account.salesforceAccountId,
account.hubspotCompanyId,
account.createdAt,
account.updatedAt,
customFields.name,
customFields.type,
customFields.variableName,
customFields.value,
workspaceDomains.domain,
workspaceDomains.role,
workspaceDomains.createdAt,
workspaceDomains.updatedAt,
workspaceUsers.role,
workspaceUsers.createdAt,
workspaceUsers.updatedAt,
workspaceUsers.user.firstName,
workspaceUsers.user.lastName,
workspaceUsers.user.avatar,
workspaceUsers.user.email,
workspaceUsers.user.name,
workspaceUsers.user.createdAt,
workspaceUsers.user.updatedAt,
deal.name,
deal.amount,
deal.closeDate,
deal.createdDate,
deal.type,
deal.stage,
deal.hubspotDealId,
deal.salesforceOpportunityId

Body

application/json
accountId
string

ID of the account to use for the workspace

autoPublishWorkspace
boolean
default:
false

Auto publish workspace

googleVerificationEnabled
boolean
default:
false

Google verification enabled

hubspotCompanyId
string

ID of the HubSpot company to use for the workspace

hubspotDealId
string

ID of the HubSpot deal to use for the workspace

Magic link verification enabled

name
string

Name of the workspace

notifyPeople
boolean
default:
false

Notify people for the workspace

salesforceAccountId
string

ID of the Salesforce account to use for the workspace

salesforceOpportunityId
string

ID of the Salesforce opportunity to use for the workspace

shareSetting
enum<string>

Share setting for the workspace

Available options:
landingPage,
withLink,
restricted
templateId
string

ID of the template to use for the workspace

welcomePageCta
string
default:
View Workspace

Welcome page CTA

welcomePageText
string

Welcome page text

workspaceDomains
object[]

Domains to access the workspace

workspaceUsers
object[]

Users to access the workspace

Response

200 - application/json
data
object