APIOrganizations
Create Org For User
Create a new organization. The authenticated user becomes the owner. If ``slug`` is omitted, one is auto-generated from the name. The org has no plan attached at creation; the require-plan route gate redirects the user to ``/plan-required`` on first navigation, where the plan picker writes the Subscription row.
Authorization
BearerAuth AuthorizationBearer <token>
Botyard API key — see /docs/authentication.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request for a user to create an organization.
Slug is optional — auto-generated from the name when omitted. The org
has no plan attached at creation; the user picks (and pays for) their
plan on /plan-required immediately after, which writes a
Subscription row.
Response Body
application/json
curl -X POST "https://example.com/v1/orgs" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{
"org_id": "string",
"name": "string",
"slug": "string",
"status": "active",
"mfa_required": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"error_code": "string",
"errors": [
{
"pointer": "string",
"detail": "string",
"type": "string"
}
],
"trace_id": "string"
}