Update Operator

Modify an existing operator’s name, phone number, email, or active flag.

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

Partial update — only the fields you supply are changed.

Requires write permission

Scope

API key scope	Behavior
Account-wide	Can update any operator in the account
Project-scoped	Returns `404` for operators not linked to the bound project

Path Parameters

Parameters

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

Request Body

Body Parameters (application/json)

Name	Type	Required	Default	Description
`name`	string	No	-	New full display name.
`phone_number`	string	No	-	New phone number. Auto-normalized to E.164.
`email`	string	No	-	Replace the contact email. Send `null` to clear.
`active`	boolean	No	-	Activate or deactivate the operator.

Request

cURL


curl -X PATCH "https://api.identitycall.ai/api/v1/public/operators/42" \
  -H "Authorization: Bearer $IDENTITYCALL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane.doe+work@example.com",
    "active": false
  }'

Python


import requests
import os
 
API_KEY = os.environ.get("IDENTITYCALL_API_KEY")
operator_id = 42
 
response = requests.patch(
    f"https://api.identitycall.ai/api/v1/public/operators/{operator_id}",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json"
    },
    json={
        "email": "jane.doe+work@example.com",
        "active": False
    }
)
 
operator = response.json()["data"]
print(f"Updated {operator['name']}: active={operator['active']}, email={operator['email']}")

Node.js


const API_KEY = process.env.IDENTITYCALL_API_KEY;
const operatorId = 42;
 
const response = await fetch(
  `https://api.identitycall.ai/api/v1/public/operators/${operatorId}`,
  {
    method: 'PATCH',
    headers: {
      'Authorization': `Bearer ${API_KEY}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      email: 'jane.doe+work@example.com',
      active: false
    })
  }
);
 
const { data: operator } = await response.json();
console.log(`Updated ${operator.name}: active=${operator.active}, email=${operator.email}`);

Response

Response200 OK

{
"data": {
  "id": 42,
  "name": "Jane Doe",
  "phone_number": "+15551234567",
  "email": "jane.doe+work@example.com",
  "active": false,
  "initials": "JD",
  "virtual_numbers": [
    {
      "id": 101,
      "phone_number": "+15558675309",
      "name": "Sales line",
      "active": true
    }
  ]
}
}

Response Fields

The same fields as Get Operator:

Field	Type	Description
`id`	integer	Unique operator ID
`name`	string	Full display name
`phone_number`	string	E.164 normalized phone number
`email`	string \| null	Contact email
`active`	boolean	Whether the operator is active
`initials`	string	Two-letter initials derived from `name`
`virtual_numbers`	array	Virtual number assignments

Errors

Status	Error	Description
401	”Invalid API key”	Missing or unrecognized bearer token
403	”Write permission required”	API key lacks write permission
404	”Resource not found”	Operator doesn’t exist, or (for project-scoped keys) is not linked to the bound project
422	`["Phone number is invalid"]`	The supplied phone number could not be normalized
422	`["Name can't be blank"]`	An empty `name` was sent