Skip to main content

CreateProviderRequest

Request schema for creating a provider

add_userboolean

Whether to grant the provider access to the dashboard.

Default value: false
display_namestringrequired

The provider's display name.

emailstringrequired

The provider's email address.

first_namestringrequired

The provider's first name.

initial_schedule object

The provider's initial schedule, created atomically with the provider when a brand-new provider row is created (ignored on reactivation or affiliation of an existing provider). All fields are optional. Omit the object or pass null for no schedules; an empty object {} still creates a schedule with effective_from defaulted to yesterday and no weekly rules.

effective_fromdate

The effective date of the schedule. Defaults to yesterday when omitted.

effective_todatenullable

The effective end date of the schedule.

public_bookings object

Public booking settings for the schedule.

enabledbooleanrequired

Whether public bookings are enabled for the schedule.

time_zonestring

The IANA time zone the weekly rules are authored in. Defaults to the provider's location time zone when omitted.

weekly_rules object[]

Weekly rules for the schedule. Defaults to none when omitted.

  • Array [
    • daystringrequired

    The day of the week.

    Possible values: [mo, tu, we, th, fr, sa, su]

    end_timestringrequired

    The end time of the rule.

    Possible values: Value must match regular expression ^(?:[01]\d|2[0-3]):[0-5]\d$

    start_timestringrequired

    The start time of the rule.

    Possible values: Value must match regular expression ^(?:[01]\d|2[0-3]):[0-5]\d$

  • ]
    • last_namestringrequired

    The provider's last name.

    metadata object

    Set of key-value pairs to attach to this provider. Maximum size is 16 KB.

    property name*any

    Set of key-value pairs to attach to this provider. Maximum size is 16 KB.

    notifyboolean

    Whether to send an email notification to the user (if add_user is true). If they don't already have an account, they will receive an email with instructions to set their password when this property is true.

    Default value: false
    role_idsstring[]

    List of role IDs to assign to the user (if add_user is true).

    Possible values: Value must match regular expression ^role_\w{12}$

    time_zonestring

    The provider's preferred IANA time zone, used as the default when authoring schedules. Defaults to the account location's time zone when omitted.

    Example: America/New_York
    CreateProviderRequest
    {
      "add_user": true,
      "display_name": "John Smith",
      "email": "john.smith@tendermedical.com",
      "first_name": "John",
      "last_name": "Smith",
      "metadata": {
        "external_id": "123"
      },
      "notify": false,
      "role_ids": [
        "role_123456789012"
      ],
      "time_zone": "America/New_York"
    }