Create provider

Create a new provider in the account.

Authorization

authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

Provider params

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for creating a provider

add_user?boolean

Whether to grant the provider access to the dashboard.

Defaultfalse

display_name*string

The provider's display name.

email*string

The provider's email address.

first_name*string

The provider's first name.

initial_schedule?

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.

last_name*string

The provider's last name.

metadata?

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

notify?boolean

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.

Defaultfalse

role_ids?array<>

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

time_zone?string

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

Response Body

`application/json`

curl -X POST "https://example.com/v1/providers" \  -H "Content-Type: application/json" \  -d '{    "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"  }'

{  "data": {    "created_at": "2017-09-12T12:34:55Z",    "display_name": "John Smith",    "email": "john@example.com",    "first_name": "John",    "id": "prov_d025a96ac0c6",    "last_name": "Smith",    "metadata": {      "external_id": "123"    },    "object": "provider",    "time_zone": "America/New_York",    "updated_at": "2017-09-13T10:11:12Z"  }}

Authorization

Request Body

Response Body

201application/json

401application/json

422application/json

`application/json`

`application/json`

`application/json`