Skip to main content
PATCH
/
v1
/
replica
/
{id}
/
chats
/
{chatId}
/
queue
/
reorder
Reorder Chat Queue
curl --request PATCH \
  --url https://api.tryreplicas.com/v1/replica/{id}/chats/{chatId}/queue/reorder \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messageId": "<string>",
  "position": 123
}
'
import requests

url = "https://api.tryreplicas.com/v1/replica/{id}/chats/{chatId}/queue/reorder"

payload = {
"messageId": "<string>",
"position": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({messageId: '<string>', position: 123})
};

fetch('https://api.tryreplicas.com/v1/replica/{id}/chats/{chatId}/queue/reorder', 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.tryreplicas.com/v1/replica/{id}/chats/{chatId}/queue/reorder",
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([
'messageId' => '<string>',
'position' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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.tryreplicas.com/v1/replica/{id}/chats/{chatId}/queue/reorder"

payload := strings.NewReader("{\n \"messageId\": \"<string>\",\n \"position\": 123\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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.tryreplicas.com/v1/replica/{id}/chats/{chatId}/queue/reorder")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"messageId\": \"<string>\",\n \"position\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.tryreplicas.com/v1/replica/{id}/chats/{chatId}/queue/reorder")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messageId\": \"<string>\",\n \"position\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "queue": [
    {
      "id": "<string>",
      "message": "<string>",
      "queuedAt": "2023-11-07T05:31:56Z",
      "senderUserId": "<string>",
      "senderEmail": "<string>",
      "senderDisplayName": "<string>"
    }
  ]
}
{
"error": "<string>",
"details": "<string>"
}
{
"error": "<string>",
"details": "<string>"
}
{
"error": "<string>",
"details": "<string>"
}
{
"error": "<string>",
"details": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the Replicas dashboard under Preferences → Organization → Settings → API Keys.

Path Parameters

id
string<uuid>
required

The unique identifier of the replica

chatId
string
required

The unique identifier of the chat

Body

application/json

Request to move a queued message to a new position.

messageId
string
required

Queued message ID.

position
integer
required

Zero-based target position.

Response

Queue reordered successfully

Result of a queue mutation.

success
boolean
required

Whether the queue mutation changed the queue.

queue
object[]
required