Difference between revisions of "Delete the Contact Personnel Detail"
Ashley DeBon (talk | contribs) (Created page with "== Remove Contact Personnel == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contacts/{id}/contact-personnel/{personnel_id} === Purpose === Removes...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| Line 40: | Line 40: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | <pre> | ||
| + | curl --location --request DELETE 'https://apimobile.callproof.com/api/contacts/{id}/contact-personnel/{personnel_id}' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' | ||
| + | </pre> | ||
| + | === cURL Example for iOS === | ||
| + | <pre> | ||
| + | curl --location --request DELETE 'https://apimobile.callproof.com/api/contacts/{id}/contact-personnel/{personnel_id}' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' | ||
| + | </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 08:42, 17 July 2026
Contents
Remove Contact Personnel
Base URL
https://apimobile.callproof.com
Endpoint
/api/contacts/{id}/contact-personnel/{personnel_id}
Purpose
Removes a person associated with a specific contact. The authenticated user must have permission to delete personnel. On success, the personnel record is removed from the contact.
HTTP Method
DELETE
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
- The authenticated user must have delete-personnel permission enabled.
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | Yes | Unique identifier of the contact that owns the personnel record |
| personnel_id | integer | Yes | Unique identifier of the person to remove |
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location --request DELETE 'https://apimobile.callproof.com/api/contacts/{id}/contact-personnel/{personnel_id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location --request DELETE 'https://apimobile.callproof.com/api/contacts/{id}/contact-personnel/{personnel_id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Indicates that the contact person 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, "Contact Personnel Removed Successfully") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – the contact person could not be removed |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – The contact ID is invalid, the personnel ID is invalid, the user does not have delete-personnel permission ("Permission denied."), or another error occurred while removing the person (for example, "Unable to delete Contact Personnel.").
- 401 – Authentication failed or the access token is missing/expired.
