Skip to main content
POST
Create onboarding portal

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Body

application/json
companyId
string<uuid>
required

Company the portal is for

templateId
string<uuid>
required

Onboarding template to instantiate

portalName
string
required
Required string length: 1 - 255
additionalTemplateIds
string<uuid>[]

Additional templates appended to the portal

Maximum array length: 10
description
string
Maximum string length: 2000
contacts
object[]
Maximum array length: 20

Response

Portal created

data
object
required