provider

admin

Update Provider

Update a provider

put/admin/providers/{provider_id}

Path parameters

provider_idstring required

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

firstNamestring nullable

lastNamestring nullable

externalIdstring nullable

emailstring nullable

phoneNumberstring nullable

addressstring nullable

addressLineTwostring nullable

citystring nullable

statestring nullable

zipCodestring nullable

countrystring nullable

addressValidboolean nullable

metaobject nullable

primaryLocationIdstring nullable

biostring nullable

Bio of the provider.

profileImagestring nullable

Profile image of the provider.

nationalProviderIdentifierstring nullable

National provider identifier of the provider.

bookingCapacityinteger nullable

Booking capacity of the provider.

showIdsboolean nullable

Whether to show IDs in the UI for this provider.

showWeekendsOnCalendarboolean nullable

Whether to show weekends on the calendar for this provider.

Response

Successful Response

idstring required

The unique identifier for the user.

firstNamestring nullable

The user's first name.

lastNamestring nullable

The user's last name.

phoneNumberstring nullable

The user's phone number.

emailstring nullable

The user's email address.

typestring required

Type of the user, fixed as 'provider'.

locationIdstring nullable

The location of the user.

externalIdstring nullable

The user's external identifier if available.

addressstring nullable

The user's primary address.

addressLineTwostring nullable

Additional address information.

citystring nullable

The city of the user's address.

statestring nullable

The state of the user's address.

zipCodestring nullable

The postal code of the user's address.

countrystring nullable

The country of the user's address.

createdDatestring date-time required

The date and time when the user was created.

addressValidboolean nullable

Whether the user's address is valid.

metaobject nullable

Any additional metadata about the user relevant to your system.

isArchivedboolean nullable

Whether the user is archived.

primaryLocationIdstring nullable

Primary location id of the provider.

lastActivestring date-time nullable

Last active date of the provider.

biostring nullable

Bio of the provider.

profileImagestring nullable

Profile image of the provider.

hasGoogleCalendarboolean

Whether the provider has a Google Calendar.

nationalProviderIdentifierstring nullable

National provider identifier of the provider.

bookingCapacityinteger nullable

Booking capacity of the provider.

showIdsboolean

Whether to show IDs in the UI for this provider.

showWeekendsOnCalendarboolean

Whether to show weekends on the calendar for this provider.

showCancelledAppointmentsboolean

Whether to show cancelled appointments in the calendar for this provider.

showMessagesBoxboolean

Whether to show the messages box in the UI for this provider.

startCalendarHourinteger nullable

The start hour of the calendar for this provider.

endCalendarHourinteger nullable

The end hour of the calendar for this provider.

sendGcalInvitesboolean

Whether to send Google Calendar invites.

calendarGridIntervalinteger nullable

Grid interval in minutes for calendar display.

appointmentTimeStepMinutesinteger nullable

Time step interval in minutes for appointment scheduling. If null, uses the smallest service duration.

showTranslucentPastEventsboolean

Whether to show translucent past events in the calendar for this provider.

showGhostEventboolean

Whether to show ghost events on hover in the calendar for this provider.

autoSignOffNotesboolean

Whether notes should automatically sign off when created.

Changes

No recorded changes to this endpoint across all 1 revision of this API.