Skip to main content
POST
/
v4
/
handoff
/
bulk
Bulk handoff appointments
curl --request POST \
  --url https://api.example.com/v4/handoff/bulk \
  --header 'Content-Type: application/json' \
  --header 'x-meetergo-api-user-id: <api-key>' \
  --data '
{
  "userId": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "start": "<string>",
  "end": "<string>",
  "targetUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enableAvailabilityCheck": true,
  "targetUserIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "appointmentIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "ignoreAvailability": true
}
'
{
  "success": [
    "<string>"
  ],
  "conflicts": [
    "<string>"
  ]
}

Authorizations

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

User ID to act as when using API Key authentication (required with API Key)

Body

application/json
​
userId
string<uuid>[]
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<uuid>

Target user ID to handoff appointments to

​
enableAvailabilityCheck
boolean

Enable availability check during handoff

​
targetUserIds
string<uuid>[]

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