PATCH a Provider Practice Group Association

patch

https://app.medallion.co/p/api/v1/provider-practice-group-associations/{id}/

Modify an existing provider practice group association

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

A UUID string identifying this provider practice group association.

Body Params

hours

array of objects

The days and times this provider works at this practice location. This is the provider's own schedule, separate from the location's hours of operation. One object per day the provider works there; a day left out is a day they don't work there. Monday is 1 and Sunday is 7. Set is_all_day or both start_hours and end_hours. Sending hours replaces the whole week, and an empty list clears it. The hours are stored on the provider's association with the location, so every group that location is in shows the same hours. Only available to organizations with provider location hours enabled.

hours

rank

integer | null

≥ 1

Position of this practice location among the provider's open locations in this group. Each group ranks its locations separately. Rank 1 is the group's primary location and rank 2 its secondary; either can be empty. Other ranked locations are 3 and up with no gaps. New locations start unranked unless you give them a rank, and unranked locations come after the ranked ones. Setting 1 or 2 puts this location in that slot and moves the location that held it to rank 3. Setting 3 or more moves it to that position among the others, or right after the last ranked one. Null removes the rank; a slot it held stays empty and the locations ranked below it move up. Null in responses for a closed or unranked location. Only available to organizations with ranked practice locations enabled.

is_primary_group

boolean

Whether this group is the provider's primary group. The rank 1 location of the primary group is the provider's overall primary practice location. Set true to make this group primary; to change it, set true on a row in another group (false is rejected). Only available to organizations with ranked practice locations enabled.

end_date

date | null

Date the provider stopped working at this practice location. It's stored on the provider's association with the location, so it applies to the location in every group the provider has it in. A date in the past closes the location, which also clears its rank. Null clears the end date.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad request

401

Unauthorized

404

Not found, or neither ranked practice locations nor provider location hours are enabled for the organization

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200