Delete the Contact Phone Based on ContactId
Contents
Remove Contact Phone
Base URL
https://apimobile.callproof.com
Endpoint
/api/contacts/{id}/phone/{phone_id}/{personnel_id}
Optional personnel segment: `/api/contacts/{id}/phone/{phone_id}` (omit `personnel_id` to delete the full phone record).
Purpose
Removes a phone number from a contact, or removes only the link between a specific person and that phone.
- When personnel_id is provided — unlinks that person from the phone; the phone record itself remains.
- When personnel_id is omitted — deletes the phone number entirely and clears related call, follow-up, and messaging references.
If the phone is set as the contact’s default number, that default is cleared before removal.
HTTP Method
DELETE
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | Yes | Unique identifier of the contact |
| phone_id | integer | Yes | Unique identifier of the phone record to remove |
| personnel_id | integer | No | When provided, only removes the association between this person and the phone (does not delete the phone record) |
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location --request DELETE 'https://apimobile.callproof.com/api/contacts/{id}/phone/{phone_id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location --request DELETE 'https://apimobile.callproof.com/api/contacts/{id}/phone/{phone_id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Indicates that the phone or personnel–phone link was removed successfully.
| Field | Type | Description |
|---|---|---|
| clientStatusCode | integer | Status indicator for the client (for example, 200) |
| user_id | integer | Identifier of the authenticated user |
| company_id | integer | Identifier of the authenticated user’s company |
| message | string | Confirmation message (for example, "The company phone number was deleted." or "The contact phone number was deleted.") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – the phone could not be removed |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – Invalid phone ID ("Contact Phone Id is Invalid"), or the phone could not be found for the given contact/company.
- 401 – Authentication failed or the access token is missing/expired.
