Difference between revisions of "Update the recommended followup on email action"
Ashley DeBon (talk | contribs) (Created page with "== Trigger Email Action on Followup Recommendation == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contacts/{id}/trigger-email-action === Purpose...") |
Ashley DeBon (talk | contribs) (→Request Body) |
||
| Line 37: | Line 37: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | |||
| + | === cURL Example for Android === | ||
| + | <pre> | ||
| + | curl --location --request POST 'https://apimobile.callproof.com/api/contacts/{id}/trigger-email-action' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' | ||
| + | </pre> | ||
| + | === cURL Example for iOS === | ||
| + | <pre> | ||
| + | curl --location --request POST 'https://apimobile.callproof.com/api/contacts/{id}/trigger-email-action' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' | ||
| + | </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 07:49, 16 July 2026
Trigger Email Action on Followup Recommendation
Base URL
https://apimobile.callproof.com
Endpoint
/api/contacts/{id}/trigger-email-action
Purpose
Records that the authenticated user has taken an email follow-up action for a recommended contact. This marks the related follow-up recommendation as completed for that contact so it no longer appears as a pending suggestion.
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 |
|---|---|---|---|
| id | string | Yes | Unique identifier of the contact for which the email follow-up action is being recorded |
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location --request POST 'https://apimobile.callproof.com/api/contacts/{id}/trigger-email-action' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location --request POST 'https://apimobile.callproof.com/api/contacts/{id}/trigger-email-action' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Indicates that the email follow-up action was recorded successfully for the specified contact’s recommendation.
| 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, "Email action triggered successfully.") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – the email follow-up action could not be completed successfully |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – The service could not update the follow-up recommendation for the given contact.
- 401 – Authentication failed or the access token is missing/expired.
