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 Favorite a Ticket API adds (or removes) the specified ticket to your list of favorite tickets.

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


Sample request

POST https://api.armor.com/tickets/271/star?on=true
POST https://api.armor.com/tickets/271/star?off=true

Input

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

API Call / URLMethod / Type
/tickets/{ticketNumber}/star?on=truePOST

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

ParameterDescriptionFormatRequired or optionalExample
ticketNumberThe number of the specific ticketIntegerRequired271
onTo add the ticket to the list of favorite ticketsStringOptional (based on desired outcome)on
offTo remove the ticket from the list of favorite ticketsStringOptional (based on desired outcome)off

Sample return

StatusResponse
200
true
403
Invalid Request
{
 "Message": "Invalid request."
}