Ctrl+K

Create an enterprise for an organization

post/api/v2/organization/{organizationId}/enterprise

Create an enterprise in the specified organization. Also create a user if it doesn't already exist.

Path Parameters

  • organizationIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Request Body

email string required
Min length: >= 1 characters
idempotencyKey string required
A unique identifier for the enterprise creation request. Multiple enterprises with the same organizationId and idempotencyKey will not be created.
additionalAdmins array[string] required
Example: 59cd72485007a239fb00282ed480da1f
accountType string
The account type for the enterprise. Defaults to 'individual' if not specified.
Allowed values: individual entity
thirdPartyIdentifier array[object]
id string required
Identifier of the third party
Min length: >= 1 characters
label string required
Label for the third party
Min length: >= 1 characters

200 Response

enterpriseId string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
userId string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[a-f0-9]{32}$

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

403 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

404 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

409 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

500 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id