Update Recording

Update metadata for an existing recording.

PATCHhttps://api.identitycall.ai/api/v1/public/recordings/:id

Update the display name of a recording.

Requires write permission

Path Parameters

Parameters

Name	Type	Required	Default	Description
`id`	integer	Yes	-	Recording ID

Request Body

Body Parameters (application/json)

Name	Type	Required	Default	Description
`display_name`	string	No	-	New display name
`tags`	string[]	No	-	Replaces the recording's entire tag set. Names are matched case-insensitively against the recording's project and created there if missing.
`operator_id`	integer \| null	No	-	Sets the operator credited with the call. Send null to clear it; omit the field to leave it unchanged.

Changing tags

tags replaces the whole set rather than adding to it, so send the tags you want the recording to end up with — not just the new ones:


# recording ends up with exactly vip + escalated, whatever it had before
curl -X PATCH "https://api.identitycall.ai/api/v1/public/recordings/$PUBLIC_ID" \
  -H "Authorization: Bearer $IDENTITYCALL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tags": ["vip", "escalated"]}'

You send	Result
`"tags": ["a", "b"]`	Recording carries exactly `a` and `b`
`"tags": []`	Every tag is removed from the recording
field omitted	Tags are left exactly as they were

To add one tag without knowing the current set, read it from Get Recording first and send the union. Removing a tag from one recording this way does not delete it from the project — for that, see Delete Tag.

Changing the operator

Use this to correct attribution after the fact, or to set it on recordings you uploaded before you had the agent roster mapped:


curl -X PATCH "https://api.identitycall.ai/api/v1/public/recordings/{public_id}" \
  -H "Authorization: Bearer $IDENTITYCALL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"operator_id": 42}'

You send	Result
`"operator_id": 42`	Operator 42 is credited, with source `api`
`"operator_id": null`	The assignment is cleared
field omitted	The existing assignment is left alone

An operator you set this way is not overwritten by voice identification or routing. See Attributing the call to an operator for how to look up ids.

Request

cURL


curl -X PATCH "https://api.identitycall.ai/api/v1/public/recordings/123" \
  -H "Authorization: Bearer $IDENTITYCALL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"display_name": "Q1 Sales Call - Updated"}'

Python


import requests
import os
 
API_KEY = os.environ.get("IDENTITYCALL_API_KEY")
recording_id = 123
 
response = requests.patch(
    f"https://api.identitycall.ai/api/v1/public/recordings/{recording_id}",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json"
    },
    json={"display_name": "Q1 Sales Call - Updated"}
)
 
recording = response.json()["data"]
print(f"Updated name: {recording['name']}")

Node.js


const API_KEY = process.env.IDENTITYCALL_API_KEY;
const recordingId = 123;
 
const response = await fetch(
  `https://api.identitycall.ai/api/v1/public/recordings/${recordingId}`,
  {
    method: 'PATCH',
    headers: {
      'Authorization': `Bearer ${API_KEY}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ display_name: 'Q1 Sales Call - Updated' })
  }
);
 
const { data: recording } = await response.json();
console.log(`Updated name: ${recording.name}`);

PHP


<?php
$apiKey = getenv('IDENTITYCALL_API_KEY');
$recordingId = 123;
 
$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => "https://api.identitycall.ai/api/v1/public/recordings/$recordingId",
    CURLOPT_CUSTOMREQUEST => "PATCH",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $apiKey",
        "Content-Type: application/json"
    ],
    CURLOPT_POSTFIELDS => json_encode(['display_name' => 'Q1 Sales Call - Updated'])
]);
 
$response = curl_exec($ch);
$recording = json_decode($response, true)['data'];
 
echo "Updated name: {$recording['name']}\n";

Ruby


require 'net/http'
require 'json'
 
API_KEY = ENV['IDENTITYCALL_API_KEY']
recording_id = 123
 
uri = URI("https://api.identitycall.ai/api/v1/public/recordings/#{recording_id}")
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = "Bearer #{API_KEY}"
request['Content-Type'] = 'application/json'
request.body = { display_name: 'Q1 Sales Call - Updated' }.to_json
 
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
 
recording = JSON.parse(response.body)['data']
puts "Updated name: #{recording['name']}"

Response

Response200 OK

{
"data": {
  "public_id": "018f3a00-0000-7000-8000-0000000000a1",
  "name": "Q1 Sales Call - Updated",
  "status": "completed",
  "language": "en",
  "duration_ms": 185000,
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T15:45:00Z",
  "dialogues_count": 24,
  "goals_evaluated": true,
  "keywords_detected": 8,
  "pauses_detected": 3,
  "audio_attached": true
}
}

Errors

Status	Error	Description
404	“Resource not found”	Recording doesn’t exist
422	Validation errors	Invalid field values

Try It

API Key

Parameters

id*

Body

display_name