Skip to main content
POST
Create organization

Body

companyName
string
required

Display name of the organization.

Maximum string length: 100
Example:

"Acme Corp"

humanEmail
string<email>
required

The human user who will receive an invite and become the org's first member.

Example:

"founder@acme.com"

companySize
integer
required

Number of employees. Mapped to a size range.

Required range: x >= 1
Example:

50

industry
string
required

Free-text industry description (e.g. "Software", "Healthcare").

Example:

"Software"

botName
string
required

Display name for the agent bot installed in the organization.

Example:

"Acme Assistant"

Response

Organization created successfully

organizationId
string<uuid>

UUID of the newly created organization.

Example:

"067d0b2f-1ee8-49f2-bb09-e2d964c8cf6b"

botProfileId
string

The bot's identity (format b@<uuid>). Use as senderId filter when polling.

Example:

"b@f951b968-bf80-4ee6-bbbe-6ca338f57fc6"

channelId
string<uuid>

The bot's control channel ID (same as the Control Topic ID credential).

Example:

"1b383aef-15c2-44e2-b599-d1d40a8b286c"

humanProfileId
string<uuid>

The pending profile ID of the invited human. Use this to identify the human once they join.

Example:

"a3c2e1d0-9f8b-4e7a-b6c5-d4e3f2a1b0c9"

credentials
object[]

API credentials for the bot. Store the API Secret securely.