API Method: POST /api/v1/uwTasks/unsubscribe
Description:
This API endpoint allows users to unsubscribe from events related to Underwriting (UW) tasks. By calling this method, the system will disable the callback URL that was previously set up to receive notifications for underwriting events, such as status changes or task updates. This is a one-time process that applies to all of your merchants, effectively stopping notifications from being sent to the callback URL.
Request:
- HTTP Method: POST
- Endpoint:
/api/v1/uwTasks/unsubscribe - Content-Type:
application/json
Request Body Parameters:
No additional request parameters are needed in the body, as this action will unsubscribe from UW task events across all merchants. Simply sending the request will deactivate the callback.
Response:
-
Status Code:
200 OK: If the unsubscription is successful.500 Internal Server Error: If there is an issue processing the request.
-
Response Body:
A confirmation message indicating the successful unsubscription from UW task events.
Example Request:
POST /api/v1/uwTasks/unsubscribe
Example Response:
{
"status": "success",
"message": "Unsubscribed successfully from UW Task events."
}
Use Case:
This API method is used when ISO/ISV, administrators, or developers wish to stop receiving notifications for UW task events across all merchants. It's useful when the callback URL is no longer needed, or if you want to disable notifications for underwriting tasks.