Difference between revisions of "Delete the Plusapp User"
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
Ashley DeBon (talk | contribs) (→cURL Example for Android) |
||
| Line 41: | Line 41: | ||
<pre> curl --location --request DELETE 'https://apimobile.callproof.com/api/user-filter/{filter_type_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | <pre> curl --location --request DELETE 'https://apimobile.callproof.com/api/user-filter/{filter_type_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location --request DELETE 'https://apimobile.callproof.com/api/user-filter/{filter_type_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === Successful Response (200) === | ||
| + | Indicates that the user filter was deleted successfully. | ||
| + | |||
| + | {| class="wikitable" | ||
| + | ! 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, "User filter has been deleted successfully.") | ||
| + | |- | ||
| + | | uri || string || Requested resource URI | ||
| + | |} | ||
=== cURL Example for iOS === | === cURL Example for iOS === | ||
Revision as of 05:32, 20 July 2026
Contents
Delete User Filter
Base URL
https://apimobile.callproof.com
Endpoint
/api/user-filter/{filter_type_id}
Purpose
Deletes the saved user filter for the authenticated user and company for the given filter type. If the deleted type is contacts (1), the related custom-fields filter (8) is also deleted.
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 |
|---|---|---|---|
| filter_type_id | integer | Yes | Filter type identifier to delete (for example, contacts = 1, custom fields = 8)
|
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location --request DELETE 'https://apimobile.callproof.com/api/user-filter/{filter_type_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location --request DELETE 'https://apimobile.callproof.com/api/user-filter/{filter_type_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Indicates that the user filter 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, "User filter has been deleted successfully.") |
| uri | string | Requested resource URI |
cURL Example for iOS
curl --location --request DELETE 'https://apimobile.callproof.com/api/user-filter/{filter_type_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Indicates that the user filter 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, "User filter has been deleted successfully.") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – the user filter could not be deleted |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while deleting the filter (for example, "Error while deleting user filter details").
- 401 – Authentication failed or the access token is missing/expired.
