Skip to main content
POST
Bulk handoff appointments

Authorizations

x-meetergo-api-user-id
string
header
required

User ID to act on behalf of. Platform API Keys only (required with an API Key unless the endpoint states otherwise). Requests authenticated with a Personal Access Token are rejected if this header names another user.

Body

application/json
userId
string[]
required

Array of user IDs to handoff appointments from

start
string
required

Period start date in ISO format

end
string
required

Period end date in ISO format

targetUserId
string

Target user ID to handoff appointments to

enableAvailabilityCheck
boolean

Enable availability check during handoff

targetUserIds
string[]

Array of target user IDs to distribute appointments across (round-robin)

appointmentIds
string<uuid>[]

Specific appointment IDs to handoff (cherry-pick). If not provided, all matching appointments are included.

ignoreAvailability
boolean

If true, ignore availability conflicts and force handoff all appointments

Response

Bulk handoff completed successfully

success
string[]
required

Array of appointment IDs that were successfully handed off

conflicts
string[]

Array of appointment IDs that could not be handed off due to conflicts