Dismiss recommended followup

From docs
Jump to: navigation, search

Dismiss Recommended Followup

Base URL

https://apimobile.callproof.com

Endpoint

/api/followup-recommendations/{contact_id}/dismiss-recommended-followup

Purpose

Allows the authenticated user to dismiss a suggested follow-up for a specific contact. Once dismissed, that recommendation is marked as completed and no longer appears as a pending follow-up suggestion for the user.

HTTP Method

POST

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter Type Required Description
contact_id string Yes Unique identifier of the contact whose recommended follow-up is being dismissed

Query Parameters

None.

Request Body

None.


cURL Example for Android

curl --location --request POST 'https://apimobile.callproof.com/api/followup-recommendations/{contact_id}/dismiss-recommended-followup' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

cURL Example for iOS

curl --location --request POST 'https://apimobile.callproof.com/api/followup-recommendations/{contact_id}/dismiss-recommended-followup' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Successful Response (200)

Indicates that the recommended follow-up was dismissed successfully for the specified contact.

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, "Recommended follow-up dismissed successfully")
uri string Requested resource URI

Error Responses

Status Code Meaning
400 Bad Request – the dismiss action could not be completed successfully
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – The service could not dismiss the follow-up recommendation for the given contact.
  • 401 – Authentication failed or the access token is missing/expired.