Skip to main content
POST
/
phone
/
release
cURL
curl --request POST \
  --url https://api.useanima.sh/v1/phone/release \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "<string>",
  "phoneNumber": "<string>"
}
'
{
  "success": "<unknown>"
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Body

application/json

Request body for releasing a phone number from an agent

​
agentId
required

Agent that currently owns the phone number

Pattern: ^[0-9a-z]+$
​
phoneNumber
string
required

E.164 formatted phone number to release

Response

200 - application/json

OK

Phone number release confirmation

​
success
any
required

Always true on successful release