curl --request PATCH \
--url https://api.telleo.ai/v1/counsellors/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"mobile_number": "+919812345678",
"airtel_extension": null
}
'import requests
url = "https://api.telleo.ai/v1/counsellors/{id}"
payload = {
"mobile_number": "+919812345678",
"airtel_extension": None
}
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({mobile_number: '+919812345678', airtel_extension: null})
};
fetch('https://api.telleo.ai/v1/counsellors/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"object": "counsellor",
"name": "<string>",
"email": "<string>",
"roles": [
"COUNSELLOR"
],
"can_call": true,
"blocked_reason": "<string>",
"status": "active",
"mobile_number": "919876543210",
"airtel_extension": "<string>",
"manageable": true,
"shared_account": true,
"created": true,
"existing_account": true,
"welcome_email_sent": true,
"effects": {},
"warnings": [
{
"field": "variables.date",
"code": "reserved_variable",
"message": "{{date}} in the agent's script is always filled with the current date and time; this value does not replace it. The agent receives it only as information about the contact."
}
],
"idempotent_replay": true
}Update a counsellor
Changes only the fields you send. name and mobile_number change only when the login belongs to your account alone; active: false deactivates and true reactivates. Admins and other staff are never changed (403).
Scope: counsellors:manage.
curl --request PATCH \
--url https://api.telleo.ai/v1/counsellors/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"mobile_number": "+919812345678",
"airtel_extension": null
}
'import requests
url = "https://api.telleo.ai/v1/counsellors/{id}"
payload = {
"mobile_number": "+919812345678",
"airtel_extension": None
}
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({mobile_number: '+919812345678', airtel_extension: null})
};
fetch('https://api.telleo.ai/v1/counsellors/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"object": "counsellor",
"name": "<string>",
"email": "<string>",
"roles": [
"COUNSELLOR"
],
"can_call": true,
"blocked_reason": "<string>",
"status": "active",
"mobile_number": "919876543210",
"airtel_extension": "<string>",
"manageable": true,
"shared_account": true,
"created": true,
"existing_account": true,
"welcome_email_sent": true,
"effects": {},
"warnings": [
{
"field": "variables.date",
"code": "reserved_variable",
"message": "{{date}} in the agent's script is always filled with the current date and time; this value does not replace it. The agent receives it only as information about the contact."
}
],
"idempotent_replay": true
}Authorizations
Your AI calling API key (vak_call_…). Authorization: Bearer <key> also works.
Path Parameters
Body
Response
The updated counsellor.
Use as counsellor_id on POST /human-calls.
"counsellor"["COUNSELLOR"]
Whether this person can take a human call right now on your calling provider.
Why can_call is false, e.g. no mobile number on their profile (Vacademy Voice, Exotel) or no Airtel extension mapped.
inactive after DELETE /counsellors/{id} (deactivated); GET /counsellors lists active ones only.
active, invited, inactive Only on GET /counsellors/{id} (and write responses) for keys with counsellors:manage, and null when the login also belongs to another account (shared_account). Digits with the country code, as stored on the profile.
"919876543210"
Only on single-counsellor responses, for keys with counsellors:manage.
Only for counsellors:manage keys: whether the API may change this person (their roles here are counsellor roles only). Admins and other staff are false.
Only for counsellors:manage keys: the login also belongs to another account on the platform, so its name and mobile number cannot be changed through the API.
true when this request made the person a counsellor here; false when they already were (nothing changed).
The email already had a login on the platform: it was reused, its name, mobile and password were not changed, and no email was sent.
On deactivation / reactivation: what else changed (see the counsellors guide).
Non-fatal notes about what was (not) done, e.g. mobile_number_missing.
Show child attributes
Show child attributes