curl --request DELETE \
--url https://api.telleo.ai/v1/counsellors/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.telleo.ai/v1/counsellors/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.telleo.ai/v1/counsellors/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "6b7e0c2a-1d3f-4e5a-8b9c-0d1e2f3a4b5c",
"object": "counsellor",
"name": "Asha Rao",
"email": "[email protected]",
"roles": [
"COUNSELLOR"
],
"status": "inactive",
"can_call": false,
"blocked_reason": "This counsellor is deactivated.",
"mobile_number": "919876543210",
"airtel_extension": null,
"manageable": true,
"shared_account": false,
"effects": {
"role_disabled": true,
"sessions_revoked": "this_account",
"pool_memberships_deactivated": 3,
"ivr_dial_steps_updated": [
{
"menu_id": "m-1",
"menu_name": "Main",
"step_id": "n-4",
"step_label": "Sales",
"no_one_left": false
}
],
"leads_reassigned": 0
}
}Deactivate a counsellor
Deactivates the counsellor in your account only: their role here is disabled (they can no longer sign in to it, other accounts are untouched), they are set inactive in every lead pool (their existing leads stay with them), they are taken out of your IVR ring lists, and inbound calls stop being routed to them. Repeating it is harmless. Reactivate with PATCH {"active": true}.
Scope: counsellors:manage.
curl --request DELETE \
--url https://api.telleo.ai/v1/counsellors/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.telleo.ai/v1/counsellors/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.telleo.ai/v1/counsellors/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "6b7e0c2a-1d3f-4e5a-8b9c-0d1e2f3a4b5c",
"object": "counsellor",
"name": "Asha Rao",
"email": "[email protected]",
"roles": [
"COUNSELLOR"
],
"status": "inactive",
"can_call": false,
"blocked_reason": "This counsellor is deactivated.",
"mobile_number": "919876543210",
"airtel_extension": null,
"manageable": true,
"shared_account": false,
"effects": {
"role_disabled": true,
"sessions_revoked": "this_account",
"pool_memberships_deactivated": 3,
"ivr_dial_steps_updated": [
{
"menu_id": "m-1",
"menu_name": "Main",
"step_id": "n-4",
"step_label": "Sales",
"no_one_left": false
}
],
"leads_reassigned": 0
}
}Authorizations
Your AI calling API key (vak_call_…). Authorization: Bearer <key> also works.
Path Parameters
Response
The deactivated counsellor, with effects.
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