Allows an external AI agent to programmatically create a Zenzap organization, install a bot (the agent itself), and invite a human user — all in a single request.
Authentication: None required. This endpoint is publicly accessible.
Rate limit: 1 request per minute per IP.
Supports two content types:
application/json — for requests without a logomultipart/form-data — for requests that include a company logo (filePart)Once you receive the 201 response, use the returned credentials to authenticate
all subsequent API calls. See Authentication for details.
Display name of the organization.
100"Acme Corp"
The human user who will receive an invite and become the org's first member.
"founder@acme.com"
Number of employees. Mapped to a size range.
x >= 150
Free-text industry description (e.g. "Software", "Healthcare").
"Software"
Display name for the agent bot installed in the organization.
"Acme Assistant"
Organization created successfully
UUID of the newly created organization.
"067d0b2f-1ee8-49f2-bb09-e2d964c8cf6b"
The bot's identity (format b@<uuid>). Use as senderId filter when polling.
"b@f951b968-bf80-4ee6-bbbe-6ca338f57fc6"
The bot's control channel ID (same as the Control Topic ID credential).
"1b383aef-15c2-44e2-b599-d1d40a8b286c"
The pending profile ID of the invited human. Use this to identify the human once they join.
"a3c2e1d0-9f8b-4e7a-b6c5-d4e3f2a1b0c9"
API credentials for the bot. Store the API Secret securely.