Page tree


In This Document 



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.




Overview

This API call applies to both Armor Complete and Armor Anywhere users.

The Post Ticket Comment API adds a comment to a ticket.

You can use the Get Ticket Meta-Data API to find the ticket number (ticketNumber).

You can use the GET https://api.armor.com/me to find your user ID.


Sample request

POST https://api.armor.com/tickets/271/comment

{
      "comment": "Please look into this ticket",
      "files": [],
      "user": {
            "name": "Jason Smith",
            "id": 2369
      }
}

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/tickets/{ticketNumber}/commentPOST

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample
ticketNumberThe number for the specific ticketIntegerRequired271
commentThe comment to add to the ticketStringRequiredPlease look into this ticket
(user) nameThe name of the userStringRequiredJason Smith
(user) idThe ID of the userIntegerRequired2369

Sample return

StatusResponse
200
{
      "comment": "adding a sample comment",
      "files": [],
      "user": {
            "name": "Test Anywhere",
            "id": 2369
      }
}
400
Bad Request
{
 "Message": "Invalid request."
}