Auphere Partner API · Guides
/ v0.1
Administrators
Decide which phone numbers may talk to a client’s agent, and what each of them is allowed to do.
In admin-only verticals the agent is a private assistant for the business, not a public chatbot. It answers only the phone numbers on this list. Anyone else who writes is recorded for audit but gets no reply — and no read receipt, so on a coexistence line the message stays unread until a human opens it.
Roles
| Role | Can do | Cannot do |
|---|---|---|
full | Everything: queries plus changes (register a payment, create an account, apply a discount…) | — |
readonly | Queries only: balances, account details, listings | Any write to your system |
The role is enforced at the runtime level, not by prompt: a readonly admin never even sees the write tools, so the agent cannot be talked into using them.
Replacing the list
PUT replaces the whole whitelist — send the complete list every time, not a delta. Requires the provision scope.
PUT https://api.auphere.com/v1/partners/clients/{external_client_ref}/admins
Authorization: Bearer ak_live_…
Content-Type: application/json
{
"admins": [
{ "phone": "+584241234567", "name": "Ana", "role": "full" },
{ "phone": "+584249990000", "name": "Luis", "role": "readonly" }
]
}{
"admin_only": true,
"admins": [
{ "phone": "+584241234567", "name": "Ana", "role": "full" },
{ "phone": "+584249990000", "name": "Luis", "role": "readonly" }
]
}phonestringRequired- E.164 recommended. We normalise formatting, but a number with fewer than 7 digits is rejected with
400— it is too ambiguous to grant admin access on. namestring- Metadata for your own traceability. It does not affect access.
role"full" | "readonly"- Defaults to
fullwhen omitted.
What happens under the hood
Each update promotes a new, audited version of the client’s agent — so a mistaken change is reversible, and you can always see who changed the whitelist and when. The change applies from the next message on; conversations in flight are not interrupted.