Queue User Group V4
Update an existing user group
PATCH
/
v4
/
queue-user-group
/
{groupId}
Update an existing user group
curl --request PATCH \
--url https://api.example.com/v4/queue-user-group/{groupId} \
--header 'Content-Type: application/json' \
--header 'x-meetergo-api-user-id: <api-key>' \
--data '
{
"name": "<string>",
"capacity": 123,
"userId": "<string>",
"userIds": [
"<string>"
],
"mainGroupHostId": "<string>"
}
'import requests
url = "https://api.example.com/v4/queue-user-group/{groupId}"
payload = {
"name": "<string>",
"capacity": 123,
"userId": "<string>",
"userIds": ["<string>"],
"mainGroupHostId": "<string>"
}
headers = {
"x-meetergo-api-user-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-meetergo-api-user-id': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
capacity: 123,
userId: '<string>',
userIds: ['<string>'],
mainGroupHostId: '<string>'
})
};
fetch('https://api.example.com/v4/queue-user-group/{groupId}', 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/queue-user-group/{groupId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'capacity' => 123,
'userId' => '<string>',
'userIds' => [
'<string>'
],
'mainGroupHostId' => '<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/queue-user-group/{groupId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"capacity\": 123,\n \"userId\": \"<string>\",\n \"userIds\": [\n \"<string>\"\n ],\n \"mainGroupHostId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/v4/queue-user-group/{groupId}")
.header("x-meetergo-api-user-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"capacity\": 123,\n \"userId\": \"<string>\",\n \"userIds\": [\n \"<string>\"\n ],\n \"mainGroupHostId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v4/queue-user-group/{groupId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-meetergo-api-user-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"capacity\": 123,\n \"userId\": \"<string>\",\n \"userIds\": [\n \"<string>\"\n ],\n \"mainGroupHostId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"capacity": 123,
"users": [
{
"id": "<string>",
"givenName": "<string>",
"familyName": "<string>",
"slug": "<string>",
"userType": "<string>",
"picture": "<string>"
}
],
"userIds": [
"<string>"
],
"queueId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"mainGroupHost": {
"id": "<string>",
"givenName": "<string>",
"familyName": "<string>",
"slug": "<string>",
"userType": "<string>",
"picture": "<string>"
},
"mainGroupHostId": "<string>",
"deletedAt": "<string>"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}Authorizations
ApiUserHeaderJWTApiKey
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.
Path Parameters
Body
application/json
Name of the user group
Group capacity (minimum 1)
User to assign or deassign from group. Deprecated: send the full userIds set instead, so the result does not depend on how current your copy of the member list is.
Full desired set of group member IDs. Replaces the membership in one transaction.
Main host user ID for the group (can be null to remove)
Response
User group updated successfully
⌘I
Update an existing user group
curl --request PATCH \
--url https://api.example.com/v4/queue-user-group/{groupId} \
--header 'Content-Type: application/json' \
--header 'x-meetergo-api-user-id: <api-key>' \
--data '
{
"name": "<string>",
"capacity": 123,
"userId": "<string>",
"userIds": [
"<string>"
],
"mainGroupHostId": "<string>"
}
'import requests
url = "https://api.example.com/v4/queue-user-group/{groupId}"
payload = {
"name": "<string>",
"capacity": 123,
"userId": "<string>",
"userIds": ["<string>"],
"mainGroupHostId": "<string>"
}
headers = {
"x-meetergo-api-user-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-meetergo-api-user-id': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
capacity: 123,
userId: '<string>',
userIds: ['<string>'],
mainGroupHostId: '<string>'
})
};
fetch('https://api.example.com/v4/queue-user-group/{groupId}', 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/queue-user-group/{groupId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'capacity' => 123,
'userId' => '<string>',
'userIds' => [
'<string>'
],
'mainGroupHostId' => '<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/queue-user-group/{groupId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"capacity\": 123,\n \"userId\": \"<string>\",\n \"userIds\": [\n \"<string>\"\n ],\n \"mainGroupHostId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/v4/queue-user-group/{groupId}")
.header("x-meetergo-api-user-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"capacity\": 123,\n \"userId\": \"<string>\",\n \"userIds\": [\n \"<string>\"\n ],\n \"mainGroupHostId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v4/queue-user-group/{groupId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-meetergo-api-user-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"capacity\": 123,\n \"userId\": \"<string>\",\n \"userIds\": [\n \"<string>\"\n ],\n \"mainGroupHostId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"capacity": 123,
"users": [
{
"id": "<string>",
"givenName": "<string>",
"familyName": "<string>",
"slug": "<string>",
"userType": "<string>",
"picture": "<string>"
}
],
"userIds": [
"<string>"
],
"queueId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"mainGroupHost": {
"id": "<string>",
"givenName": "<string>",
"familyName": "<string>",
"slug": "<string>",
"userType": "<string>",
"picture": "<string>"
},
"mainGroupHostId": "<string>",
"deletedAt": "<string>"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}