> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Elevate API

> Set up Elevate phone users with a licence, a pooled number and an extension, remove leavers, and read customer accounts, numbers, devices and licences

The common use is an onboarding agent that creates the new hire in the customer's Elevate account and turns on their Voice Service with a number from the account's pool and a free extension, and an offboarding agent that turns the leaver's Voice Service off and deletes the user.

> [!NOTE]
>
> Automatically enabled when you configure Elevate permissions in your agent workflow.

## What It Does

* Find the customer's Elevate account from the company mapping, or by name
* Create, update and delete users
* Turn a user's Voice Service on with a licence, a number from the pool and an extension, and off again, then confirm the change finished
* Read the account's free numbers and extensions, numbers, trunks and number history
* Read and manage locations, voice devices, licences and products
* Read and manage customer accounts and their Control Panel contacts
* Read the payment method type and the usage report

## Permission Groups

| Group | Covers |
| - | - |
| Customer Accounts | Customer accounts, company details, state, MSA and external fields |
| Users | Users in a customer account |
| Voice Service and Locations | The Voice Service of an account and its users, free extensions, and locations |
| Phone Numbers | An account's numbers and free pool, number details and history, trunks, imports and releases |
| Voice Devices | Desk phones and other voice devices, their models and imports |
| Licenses and Products | An account's licences and products; buying and cancelling licences |
| Partner Contacts | Control Panel contacts linked to an account and their roles |
| Payment Method and Usage | The payment method type and the partner usage report |

## Access Profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read | No write is allowed |
| **Helpdesk** | Every read | Every write |
| **IT Admin** | Every read, and users, Voice Service, numbers and devices | Accounts, contacts, licences and payment method |
| **Full Automation** | Every read and every write | Deleting a customer account |

## Safety Controls

| Control | Behavior |
| - | - |
| **Writes** | Neo sends only the writes the Partner API documents. Every other write is refused |
| **Account delete** | Deleting a customer account always asks a technician, whatever the profile, because Elevate deletes all its data for good |
| **Numbers** | The agent takes a number from the account's pool, so it never buys a new number from Elevate's inventory unless asked |
| **Payment details** | Neo never sends card or bank details; you enter them in the Partner Portal |
| **Temporary passwords** | The agent takes a new user's temporary password from [Generate Password](https://docs.neoagent.io/agents/tools/management/generate-password.md) and delivers it as a secure link to the person the ticket or your instructions name. It never writes the password in a ticket note |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.