Skip to content
Bottle

Create a business

POST
/tenants
curl --request POST \
  --url https://example.com/tenants \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Acme Gas", "signupCode": "example", "plan": "starter" }'

Creates the tenant and makes you its owner. While tenant creation is invite only, a valid signup code is required; registering an account is always open, so an invited driver can join without one.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 2 characters <= 120 characters
Example
Acme Gas
signupCode
string
>= 1 characters <= 64 characters
plan
string
Allowed values: starter round depot

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
name
required
string
slug
required
string
createdAt
required
string format: date-time
Example
{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "name": "Acme Gas",
  "slug": "acme-gas"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Email not confirmed, or a missing or spent signup code

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}