Difference between revisions of "Delete Business Card details"
Ashley DeBon (talk | contribs) (Created page with "== Delete Business Card == === Base URL === https://apimobile.callproof.com === Endpoint === /api/delete-business-cards === Purpose === Deletes a business card for the auth...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| Line 42: | Line 42: | ||
| delete_type || integer || Yes || Delete mode: <code>1</code> = delete from scanner, <code>2</code> = delete from CallProof | | delete_type || integer || Yes || Delete mode: <code>1</code> = delete from scanner, <code>2</code> = delete from CallProof | ||
|} | |} | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | <pre> | ||
| + | curl --location --request POST 'https://apimobile.callproof.com/api/delete-business-cards' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ | ||
| + | --form 'id=6789' \ | ||
| + | --form 'delete_type=1' | ||
| + | </pre> | ||
| + | === cURL Example for iOS === | ||
| + | <pre> | ||
| + | curl --location --request POST 'https://apimobile.callproof.com/api/delete-business-cards' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ | ||
| + | --form 'id=6789' \ | ||
| + | --form 'delete_type=1' | ||
| + | </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 14:32, 17 July 2026
Contents
Delete Business Card
Base URL
https://apimobile.callproof.com
Endpoint
/api/delete-business-cards
Purpose
Deletes a business card for the authenticated user. Behavior depends on delete_type:
1– Marks the card as deleted from the scanner (soft delete; card is hidden from the scanner list)2– Permanently deletes the card from CallProof, including related contact images and stored front/back image files
HTTP Method
POST
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | Yes | Unique identifier of the business card to delete (must exist) |
| delete_type | integer | Yes | Delete mode: 1 = delete from scanner, 2 = delete from CallProof
|
cURL Example for Android
curl --location --request POST 'https://apimobile.callproof.com/api/delete-business-cards' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --form 'id=6789' \ --form 'delete_type=1'
cURL Example for iOS
curl --location --request POST 'https://apimobile.callproof.com/api/delete-business-cards' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --form 'id=6789' \ --form 'delete_type=1'
Successful Response (200)
Indicates that the business card was deleted 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 business card details are deleted successfully.") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 200 | Validation failed – response body uses clientStatusCode 401 with the first validation error message
|
| 400 | Bad Request – the business card could not be deleted |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- Validation (HTTP 200, clientStatusCode 401) – Missing
id/delete_type, invalid card ID, ordelete_typenot in1,2. - 400 – Card not found for the user/company, or another delete error (for example, "Error while deleting the business card details").
- 401 – Authentication failed or the access token is missing/expired.
