Hand-offs
Update a hand-off
Change status or assignment.
Credential: user token · Role: owner, admin or responder (reply)
Mirrors the hand-off console’s status and assign controls. A developer or viewer token is refused.
PATCH
/
v1
/
handoffs
/
{id}
Update a hand-off
curl --request PATCH \
--url https://api.peeve.ai/v1/handoffs/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "resolved"
}
'import requests
url = "https://api.peeve.ai/v1/handoffs/{id}"
payload = { "status": "resolved" }
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({status: 'resolved'})
};
fetch('https://api.peeve.ai/v1/handoffs/{id}', 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.peeve.ai/v1/handoffs/{id}",
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([
'status' => 'resolved'
]),
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.peeve.ai/v1/handoffs/{id}"
payload := strings.NewReader("{\n \"status\": \"resolved\"\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.peeve.ai/v1/handoffs/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"resolved\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peeve.ai/v1/handoffs/{id}")
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 \"status\": \"resolved\"\n}"
response = http.request(request)
puts response.read_body{
"object": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>",
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ask": "<string>",
"stop_reason": "<string>",
"ticket_ref": "<string>",
"route": "<string>",
"destructive": true,
"requester_label": "<string>",
"confidence": 123,
"intent": "<string>",
"intent_confidence": 123,
"intent_at": "2023-11-07T05:31:56Z",
"resolution_reason": "<string>",
"resolution_confidence": 123,
"resolution_at": "2023-11-07T05:31:56Z",
"resolved_at": "2023-11-07T05:31:56Z",
"assigned_at": "2023-11-07T05:31:56Z",
"external_responder": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"request_id": "<string>"
}Authorizations
A user token (pv_ut_…) as Authorization: Bearer pv_ut_…. X-Peeve-Key is accepted too. Never a query parameter — URLs end up in proxy logs and Referer headers.
The token carries its owner's live workspace role, re-read on every call.
Path Parameters
Body
application/json
Available options:
open, pending, resolved, closed ⌘I
Update a hand-off
curl --request PATCH \
--url https://api.peeve.ai/v1/handoffs/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "resolved"
}
'import requests
url = "https://api.peeve.ai/v1/handoffs/{id}"
payload = { "status": "resolved" }
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({status: 'resolved'})
};
fetch('https://api.peeve.ai/v1/handoffs/{id}', 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.peeve.ai/v1/handoffs/{id}",
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([
'status' => 'resolved'
]),
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.peeve.ai/v1/handoffs/{id}"
payload := strings.NewReader("{\n \"status\": \"resolved\"\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.peeve.ai/v1/handoffs/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"resolved\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peeve.ai/v1/handoffs/{id}")
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 \"status\": \"resolved\"\n}"
response = http.request(request)
puts response.read_body{
"object": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>",
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ask": "<string>",
"stop_reason": "<string>",
"ticket_ref": "<string>",
"route": "<string>",
"destructive": true,
"requester_label": "<string>",
"confidence": 123,
"intent": "<string>",
"intent_confidence": 123,
"intent_at": "2023-11-07T05:31:56Z",
"resolution_reason": "<string>",
"resolution_confidence": 123,
"resolution_at": "2023-11-07T05:31:56Z",
"resolved_at": "2023-11-07T05:31:56Z",
"assigned_at": "2023-11-07T05:31:56Z",
"external_responder": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"request_id": "<string>"
}