Update call
curl --request PATCH \
--url https://api.callrounded.com/v1/calls/{call_id} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"metadata": {
"source": "marketing_campaign",
"utm_medium": "email"
},
"override": false
}
'import requests
url = "https://api.callrounded.com/v1/calls/{call_id}"
payload = {
"metadata": {
"source": "marketing_campaign",
"utm_medium": "email"
},
"override": False
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({metadata: {source: 'marketing_campaign', utm_medium: 'email'}, override: false})
};
fetch('https://api.callrounded.com/v1/calls/{call_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.callrounded.com/v1/calls/{call_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([
'metadata' => [
'source' => 'marketing_campaign',
'utm_medium' => 'email'
],
'override' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <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.callrounded.com/v1/calls/{call_id}"
payload := strings.NewReader("{\n \"metadata\": {\n \"source\": \"marketing_campaign\",\n \"utm_medium\": \"email\"\n },\n \"override\": false\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<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.callrounded.com/v1/calls/{call_id}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {\n \"source\": \"marketing_campaign\",\n \"utm_medium\": \"email\"\n },\n \"override\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.callrounded.com/v1/calls/{call_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": {\n \"source\": \"marketing_campaign\",\n \"utm_medium\": \"email\"\n },\n \"override\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"from_number": "<string>",
"to_number": "<string>",
"organization_id": "123e4567-e89b-12d3-a456-426614174001",
"type": "phone_call",
"agent_id": "123e4567-e89b-12d3-a456-426614174002",
"metadata": {
"source": "marketing_campaign",
"utm_medium": "email"
},
"start_time": "2023-06-15T14:30:00Z",
"end_time": "2023-06-15T14:35:00Z",
"duration_seconds": 300,
"redirect_duration_seconds": 5,
"cost": 0.15,
"transcript_string": "Agent: Hello, how can I help you today?\nUser: I'd like to check on my order status.",
"transcript": [
{
"start_time": "2023-11-07T05:31:56Z",
"content": "<string>"
}
],
"variable_values": [
{
"name": "<string>",
"value": "John Doe",
"timestamp": "2023-06-15T14:33:12Z"
}
],
"post_call_answers": [
{
"id": "<string>",
"question": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"is_optional": true
},
"has_answer": true,
"answer_text": "The customer expressed satisfaction with the resolution.",
"answer_number": 8.5,
"answer_boolean": true,
"selected_options": [
{
"option": {
"id": "<string>",
"value": "<string>"
}
}
]
}
],
"answer_type": "human",
"recording_url": "https://rounded-storage.s3.amazonaws.com/calls/test?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=TEST%2F20250401%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20250401T163838Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=046d4f7da8a7f2343875872593cbaa94a7836c42e1fd669e91fc2af9cf2b43be",
"secure_recording_url": true
},
"message": "Call retrieved successfully",
"error": {
"details": [
{
"field": "email",
"message": "Invalid email format"
}
],
"message": "An error occurred while processing your request",
"status": 400,
"type": "generic_error"
},
"status": 200
}calls
Update call
Update a call with additional metadata. The call can be either a phone call or a web call. The response includes the updated call details. If override is True, existing metadata will be completely replaced with new metadata, including None values.
PATCH
/
v1
/
calls
/
{call_id}
Update call
curl --request PATCH \
--url https://api.callrounded.com/v1/calls/{call_id} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"metadata": {
"source": "marketing_campaign",
"utm_medium": "email"
},
"override": false
}
'import requests
url = "https://api.callrounded.com/v1/calls/{call_id}"
payload = {
"metadata": {
"source": "marketing_campaign",
"utm_medium": "email"
},
"override": False
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({metadata: {source: 'marketing_campaign', utm_medium: 'email'}, override: false})
};
fetch('https://api.callrounded.com/v1/calls/{call_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.callrounded.com/v1/calls/{call_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([
'metadata' => [
'source' => 'marketing_campaign',
'utm_medium' => 'email'
],
'override' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <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.callrounded.com/v1/calls/{call_id}"
payload := strings.NewReader("{\n \"metadata\": {\n \"source\": \"marketing_campaign\",\n \"utm_medium\": \"email\"\n },\n \"override\": false\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<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.callrounded.com/v1/calls/{call_id}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {\n \"source\": \"marketing_campaign\",\n \"utm_medium\": \"email\"\n },\n \"override\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.callrounded.com/v1/calls/{call_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": {\n \"source\": \"marketing_campaign\",\n \"utm_medium\": \"email\"\n },\n \"override\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"from_number": "<string>",
"to_number": "<string>",
"organization_id": "123e4567-e89b-12d3-a456-426614174001",
"type": "phone_call",
"agent_id": "123e4567-e89b-12d3-a456-426614174002",
"metadata": {
"source": "marketing_campaign",
"utm_medium": "email"
},
"start_time": "2023-06-15T14:30:00Z",
"end_time": "2023-06-15T14:35:00Z",
"duration_seconds": 300,
"redirect_duration_seconds": 5,
"cost": 0.15,
"transcript_string": "Agent: Hello, how can I help you today?\nUser: I'd like to check on my order status.",
"transcript": [
{
"start_time": "2023-11-07T05:31:56Z",
"content": "<string>"
}
],
"variable_values": [
{
"name": "<string>",
"value": "John Doe",
"timestamp": "2023-06-15T14:33:12Z"
}
],
"post_call_answers": [
{
"id": "<string>",
"question": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"is_optional": true
},
"has_answer": true,
"answer_text": "The customer expressed satisfaction with the resolution.",
"answer_number": 8.5,
"answer_boolean": true,
"selected_options": [
{
"option": {
"id": "<string>",
"value": "<string>"
}
}
]
}
],
"answer_type": "human",
"recording_url": "https://rounded-storage.s3.amazonaws.com/calls/test?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=TEST%2F20250401%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20250401T163838Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=046d4f7da8a7f2343875872593cbaa94a7836c42e1fd669e91fc2af9cf2b43be",
"secure_recording_url": true
},
"message": "Call retrieved successfully",
"error": {
"details": [
{
"field": "email",
"message": "Invalid email format"
}
],
"message": "An error occurred while processing your request",
"status": 400,
"type": "generic_error"
},
"status": 200
}Authorizations
The API Key created in Rounded Studio.
- You can create it by going to the "API Keys" settings of your profile.
- Need help? You can email us at team@callrounded.com or join our Discord community.
Path Parameters
Body
application/json
Schema for updating a call with metadata.
Additional metadata to associate with the call.
Example:
{
"source": "marketing_campaign",
"utm_medium": "email"
}
If True, existing metadata will be completely replaced with new metadata. If False, existing metadata will be merged with new metadata.
Response
Successfully updated call information
The call data retrieved.
- PhoneCallGetApiResponseData
- WebCallGetApiResponseData
Show child attributes
Show child attributes
Response message indicating the result of the operation.
Show child attributes
Show child attributes
Example:
{
"details": [
{
"field": "email",
"message": "Invalid email format"
}
],
"message": "An error occurred while processing your request",
"status": 400,
"type": "generic_error"
}
HTTP status code of the response.
⌘I