Skip to main content
DELETE
/
phone-aliases
Delete phone book contacts
curl --request DELETE \
  --url https://app.freyavoice.ai/api/v2/phone-aliases \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "message": "<string>",
    "result": {
      "success": true,
      "deletedCount": 123,
      "errors": [
        {
          "id": "<string>",
          "error": "<string>"
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

phoneAliasIds
string
required

Comma-separated contact IDs to delete

Minimum string length: 1

Response

Contacts deleted

success
enum<boolean>
required
Available options:
true
data
object
required