API Documentation
Agents
Phone Numbers
SIP
Messaging
Webhooks
Knowledge
Accounts
- POSTCreate a new reseller
- GETList resellers
- POSTCreate a new organization
- DELDelete an organization
- GETList organizations
- GETList agent accounts
- POSTCreate a new account
- DELDelete an account
- GETList admin users
- DELDelete admin user
- POSTInvite admin user
- GETFetch Account by externalAccountId
- POSTUpdate Organization Settings
Billing
Return / Unassign Phone Number
Return a phone number and unassigns the number from the agent account. If provided by an external integrated number supplier, will return to them too. Requires reseller account.
POST
/
api
/
v2
/
phoneNumber
/
return
Return / Unassign Phone Number
Copy
Ask AI
curl --request POST \
--url https://api.vida.dev/api/v2/phoneNumber/return \
--header 'Content-Type: application/json' \
--data '{
"number": "+12145551234"
}'
Copy
Ask AI
{
"success": true,
"message": "Success"
}
Authorizations
Vida API Token
Body
application/json
Response
200
application/json
Successfully returned phone number
The response is of type object
.
Return / Unassign Phone Number
Copy
Ask AI
curl --request POST \
--url https://api.vida.dev/api/v2/phoneNumber/return \
--header 'Content-Type: application/json' \
--data '{
"number": "+12145551234"
}'
Copy
Ask AI
{
"success": true,
"message": "Success"
}
Assistant
Responses are generated using AI and may contain mistakes.