Handoff V4

Bulk handoff appointments

Hands off multiple appointments from specified users within a time period to a target user.

post/v4/handoff/bulk

Request

  • Base URL: https://developer.meetergo.com (the document declares no server; this is the origin it was published from)
  • URL: https://developer.meetergo.com/v4/handoff/bulk
  • Auth: one of:
    • API key in header x-meetergo-api-user-id
    • HTTP bearer
    • HTTP bearer

Request body

userIdstring[] required

Array of user IDs to handoff appointments from

startstring required

Period start date in ISO format

endstring required

Period end date in ISO format

targetUserIdstring

Target user ID to handoff appointments to

enableAvailabilityCheckboolean

Enable availability check during handoff

targetUserIdsstring[]

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

appointmentIdsstring[]

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

ignoreAvailabilityboolean

If true, ignore availability conflicts and force handoff all appointments

Response

Bulk handoff completed successfully

successstring[] required

Array of appointment IDs that were successfully handed off

conflictsstring[]

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

Changes

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