Add a comment to UW Task ticket

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Add a Comment to UW Task Ticket

Adds a text comment to a specific underwriting task (UW ticket) associated with a merchant. Comments are the primary communication mechanism between ISOs, merchants, and the underwriting team within a UW task. They can be used to ask questions, provide status updates, or log decisions related to the task.

Endpoint

POST /api/v1/uwTasks/ticket/addComment

Authentication

Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:

Authorization: Basic {base64(username:password)}

When to use

Use this endpoint when you need to communicate with the underwriting team about a specific task, or when the UW team needs to leave instructions for the ISO regarding required documentation. This is particularly useful after uploading new documents to explain what was provided, or to respond to an underwriter's request for clarification. Comments are timestamped and attributed to the authenticated user.

Request Body

FieldTypeRequiredDescription
idinteger (int32)YesMerchant profile ID that owns the UW task
ticketIdinteger (int32)YesID of the UW task ticket to add the comment to
textstringYesThe comment text to add to the ticket
{
  "id": 48201,
  "ticketId": 1073,
  "text": "We have uploaded the requested bank statements covering the past 3 months. Please let us know if additional documentation is needed."
}

Response

200 OK

FieldTypeDescription
statusstring (enum)HTTP status name, e.g., "OK"
errorstringError message if the operation failed
warningstringNon-fatal warning message
validationResultsarrayField-level validation errors, if any
requestIdintegerUnique identifier for this API request
{
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 88437
}

Error Codes

CodeWhen it happens
400Required fields (id, ticketId, text) are missing or empty
401Invalid or missing Basic Auth credentials
403User does not have permission for this operation
404Merchant or ticket not found
500Internal server error

Common Mistakes

  • Omitting the text field or sending an empty string — all three fields are required.
  • Using the wrong ticketId; UW tickets are distinct from general support tickets. Retrieve valid ticket IDs from GET /api/v1/uwTasks/getByMerchantId.
  • Comments do not automatically notify the UW team that documents have been uploaded; for that, also call POST /api/v1/uwTasks/setStatusInReview.

Related Endpoints

  • GET /api/v1/uwTasks/ticket/getCommentsByTicketId — retrieve all comments on a ticket
  • GET /api/v1/uwTasks/getByMerchantId — get the list of UW task tickets for a merchant
  • POST /api/v1/uwTasks/ticket/addAttachment — attach a document to the same ticket

Example

curl -X POST https://hq.staging.netevia.dev/api/v1/uwTasks/ticket/addComment \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 48201,
    "ticketId": 1073,
    "text": "We have uploaded the requested bank statements covering the past 3 months."
  }'
Body Params
int32
int32
string
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json