View source for Add Plusapp User Filterss

== Add User Filter ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/user-filter

=== Purpose ===
Saves a user filter for the authenticated user and company. If a filter of the same type already exists for that user, it is updated; otherwise a new filter is created.

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
None.

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| filter_type_id || integer || Yes || Filter type identifier (for example, contacts = <code>1</code>, custom fields = <code>8</code>)
|-
| filter || string || Yes || Filter criteria payload to store (typically a JSON string of filter settings)
|}

=== cURL Example for Android ===

<pre> curl --location --request POST 'https://apimobile.callproof.com/api/user-filter' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --form 'filter_type_id=1' \ --form 'filter={}' </pre>

=== cURL Example for iOS ===

<pre> curl --location --request POST 'https://apimobile.callproof.com/api/user-filter' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --form 'filter_type_id=1' \ --form 'filter={}' </pre>

=== Successful Response (200) ===
Indicates that the user filter was created or updated 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 added successfully." or "User filter updated successfully.")
|-
| uri || string || Requested resource URI
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation failed – response body uses <code>clientStatusCode</code> 401 with the first validation error message
|-
| 400 || Bad Request – the user filter could not be saved
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation (HTTP 200, clientStatusCode 401)''' – Missing <code>filter_type_id</code> or <code>filter</code>.
* '''400''' – An error occurred while adding/updating the filter (for example, "Error while adding user filter details").
* '''401''' – Authentication failed or the access token is missing/expired.