Skip to main content
POST
/
v4
/
handoff
/
appointment
Handoff appointment to another user or queue
curl --request POST \
  --url https://api.example.com/v4/handoff/appointment \
  --header 'Content-Type: application/json' \
  --header 'x-meetergo-api-user-id: <api-key>' \
  --data '
{
  "appointmentId": "<string>",
  "userId": "<string>",
  "queueId": "<string>",
  "queueGroupId": "<string>"
}
'
import requests

url = "https://api.example.com/v4/handoff/appointment"

payload = {
"appointmentId": "<string>",
"userId": "<string>",
"queueId": "<string>",
"queueGroupId": "<string>"
}
headers = {
"x-meetergo-api-user-id": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-meetergo-api-user-id': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
appointmentId: '<string>',
userId: '<string>',
queueId: '<string>',
queueGroupId: '<string>'
})
};

fetch('https://api.example.com/v4/handoff/appointment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v4/handoff/appointment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'appointmentId' => '<string>',
'userId' => '<string>',
'queueId' => '<string>',
'queueGroupId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-meetergo-api-user-id: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v4/handoff/appointment"

payload := strings.NewReader("{\n \"appointmentId\": \"<string>\",\n \"userId\": \"<string>\",\n \"queueId\": \"<string>\",\n \"queueGroupId\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-meetergo-api-user-id", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v4/handoff/appointment")
.header("x-meetergo-api-user-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"appointmentId\": \"<string>\",\n \"userId\": \"<string>\",\n \"queueId\": \"<string>\",\n \"queueGroupId\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v4/handoff/appointment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-meetergo-api-user-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"appointmentId\": \"<string>\",\n \"userId\": \"<string>\",\n \"queueId\": \"<string>\",\n \"queueGroupId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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
appointmentId
string
required

ID of the appointment to handoff

userId
string

ID of user to handoff appointment to

queueId
string

ID of queue to handoff appointment to

queueGroupId
string

ID of queue group to handoff appointment to

Response

Appointment successfully handed off