Skip to main content
POST
Activate a draft company
Key: Write Scope: Workspace

Authorizations

Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Path Parameters

companyId
string
required

Response

default - application/json
id
string
required

Unique company identifier

name
string
required

Company display name

createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
domainName
string | null
required

Primary email domain of the company

status
enum<string> | null
required

Derived from the subscription: DEMO for a demo company, TRIAL / TRIAL_EXPIRED during a trial, DRAFT before activation, otherwise ACTIVE. A demo company reads DEMO from the moment the option is set, so use isDraft — not status — to tell whether it has been activated

Available options:
DRAFT,
ACTIVE,
INACTIVE,
DEMO,
TRIAL,
TRIAL_EXPIRED
isDraft
boolean
required

True until the company is activated: it is not usable yet, and its options can still be changed

options
object | null
required