Add a comment to UW Task ticket

API Method: POST /api/v1/uwTasks/ticket/addComment

Description:

This API endpoint allows users to add a comment to a specific Underwriting (UW) task ticket. Underwriting tasks often involve back-and-forth communication between merchants, administrators, and the underwriting team. This endpoint enables users to leave comments on a task to provide additional context, ask questions, or give updates on the progress of the underwriting process.

Request:

• HTTP Method: POST
• Endpoint: /api/v1/uwTasks/ticket/addComment
• Content-Type: application/json

Request Body Parameters:

The request body must be in JSON format and include the following fields:

• ID (required):
  The unique identifier of the merchant whose UW task is being updated with a comment.

  • Type: int32
  • Example: "ID": 12345

• ticketId (required):
  The identifier of the specific underwriting task (ticket) to which the comment is being added.

  • Type: int32
  • Example: "ticketId": 67890

• text (required):
  The comment or message to be added to the underwriting task ticket. This could be a question, clarification, or update related to the task.

  • Type: string
  • Example: "text": "Please review the attached bank statements for accuracy"

Response:

• Status Code:

  • 200 OK: If the comment is successfully added to the UW task.
  • 400 Bad Request: If the ID, ticketId, or text fields are missing or invalid.
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  A confirmation message or details of the newly added comment.

Example Request:

POST /api/v1/uwTasks/ticket/addComment
Content-Type: application/json

{
  "ID": 12345,
  "ticketId": 67890,
  "text": "Please review the attached bank statements for accuracy"
}

Use Case:

This API method is used by ISO/ISV, administrators, or underwriting teams to add comments to specific underwriting tasks. It facilitates communication and helps track notes, questions, or updates related to the task, ensuring a smoother underwriting process.