Skip to main content
Create a new platform user with automatic availability and meeting type setup, making them immediately ready for bookings.
Creating platform users requires an active API Platform subscription and a company admin acting user. Personal Access Tokens cannot create users — authenticate with a Platform API Key.

Endpoint

Request Headers

Request Body

Basic Fields

Optional: Custom Availability

Optional: Custom Meeting Type

Examples

Basic Request

With Custom Availability & Meeting Type

With Split Availability (Lunch Break)

Response

Success (201 Created)

User Ready! The user is immediately ready for bookings. The bookingUrl can be shared with customers right away.
What was created automatically:
  • Platform user with the provided details
  • Default availability schedule (Mon-Fri 8-17 if not specified)
  • Default meeting type (30min Meeting if not specified)
  • Public booking URL for immediate use

Error Responses

400 Bad Request - Validation Error

400 Bad Request - Invalid Timezone

403 Forbidden - No API Platform Subscription

409 Conflict - Email Already Exists

Availability Schedule Format

The schedule is an object with a property for each day of the week. See the full schedule format reference.

Day Schedule Structure

Each day has two properties:

Time Format

Times are in 24-hour format (HH:MM):
Set enabled: false on days that should be unavailable (e.g., weekends). Days with enabled: true must include at least one time range in hours.

Meeting Type Channel Values

The channel field controls where the meeting takes place:

Common Timezones

See the full list of IANA timezone identifiers.