Update

View as Markdown
# Create Tenant Endpoint This endpoint allows users to create a new tenant. Upon successful creation of a tenant, several related endpoints for managing locations under that tenant are available. ## Related Endpoints Once a tenant is created, the following endpoints can be utilized to manage locations associated with that tenant: 1. **List Locations** - **GET** `{{url}}/tenants/{tenant_id}/locations` - Description: Retrieves a list of all locations associated with the specified tenant. 2. **Create Location** - **POST** `{{url}}/tenants/{tenant_id}/locations` - Description: Creates a new location for the specified tenant. 3. **Get Single Location** - **GET** `{{url}}/tenants/{tenant_id}/locations/{id}` - Description: Retrieves details of a specific location associated with the specified tenant. 4. **Update Location** - **PUT** `{{url}}/tenants/{tenant_id}/locations/{id}` - Description: Updates the details of a specific location associated with the specified tenant. 5. **Delete Location** - **DELETE** `{{url}}/tenants/{tenant_id}/locations/{id}` - Description: Deletes a specific location associated with the specified tenant. ## Request Body The request body for creating a tenant should include the necessary parameters to define the tenant's details. ## Response Upon successful creation of a tenant, the response will confirm the creation and may include details of the newly created tenant. This endpoint is essential for setting up a new tenant and managing its locations effectively.

Request

This endpoint expects a multipart form.
citystringRequired

Optional: City

namestringRequired

Required: Name of the company

phonestringRequired

Optional: Phone

statestringRequired

Optional: State

websitestringRequired

Optional: Website

zipcodestringRequired

Optional: Zipcode

address1stringRequired

Optional: Address 1

address2stringRequired

Optional: Address 2

timezonestringRequired

Optional: IANA timezone name (e.g. America/New_York, Europe/London). Drives business-hours-aware behavior — e.g. Communications inbound-callback routing reads location.timezone first, then falls back to tenant.timezone, then config(‘app.timezone’). Validates against PHP timezone:all rule.

descriptionstringRequired

Optional: Description

for_testingstringRequired

Optional: Default is true

Response

Successful response