Provision an organization (service key)

curl --request POST \
  --url https://api.zelto.ai/v1/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "ownerEmail": "jsmith@example.com",
  "timezone": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "orgUrl": "<string>",
  "ownerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": {
    "org": true,
    "user": true
  }
}

Organizations

Provision an organization (service key)

Create a Zelto organization headlessly from an automation (e.g. a Slack/CRM provisioner) during a sales call. Finds-or-creates the owner user by email, creates the org and an owner member, seeds signup credits, mirrors to the analytical store, and emails the owner an invite to set up their login.

Requires an admin/service API key — read-only org-scoped customer keys are rejected with 403. Idempotent: a repeat call with the same owner email and org name returns the existing org (created.org=false) instead of duplicating.

POST

organizations

curl --request POST \
  --url https://api.zelto.ai/v1/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "ownerEmail": "jsmith@example.com",
  "timezone": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "orgUrl": "<string>",
  "ownerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": {
    "org": true,
    "user": true
  }
}

Authorizations

Authorization

string

header

required

Send Authorization: Bearer YOUR_API_KEY. The key resolves to a single organization.

Body

application/json

name

string

required

Organization display name.

Required string length: 1 - 255

ownerEmail

string<email>

required

Email of the org owner; the user is found-or-created.

Maximum string length: 255

timezone

string

IANA timezone (e.g. America/New_York). Defaults to UTC.

defaultLocale

enum<string>

Default locale for the org. Defaults to en-us.

Available options:

en-us,

es,

pt

Response

Existing organization returned (idempotent repeat).

string<uuid>

required

slug

string

required

URL slug, <name>-<8 hex>.

orgUrl

string<uri>

required

Absolute URL to the org dashboard.

ownerUserId

string<uuid>

required

created

object

required

Whether each entity was newly created (vs. reused).

Show child attributes

Add a comment or annotation