Skip to main content
POST
/
v1
/
auth
/
bootstrap
Bootstrap first workspace
curl --request POST \
  --url https://api.example.com/v1/auth/bootstrap \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_name": "<string>"
}
'
{
  "workspace": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "plan": "<string>",
    "plan_status": "<string>",
    "beta_override": true,
    "emails_sent_this_period": 123,
    "inbound_received_this_period": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "trial_ends_at": "2023-11-07T05:31:56Z",
    "current_period_start": "2023-11-07T05:31:56Z",
    "current_period_end": "2023-11-07T05:31:56Z"
  },
  "api_key": "<string>",
  "warning": "<string>"
}

Body

application/json
workspace_name
string
required

Response

Successful Response

workspace
WorkspaceResponse · object
required
api_key
string
required
warning
string
required