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.

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"
}