Create a tag (Called a "list" within the GUI application).


JSON Request Example:    

{
  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Tags",
  "requestmethod": "CreateTag",
  "details": {
    "name": "{*name*}", /* required */
    "description": "{*description*}"
  }
}

XML

 "json_request" element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeTags
requestmethodCreateTag


Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call. For example, If no description is to be added, remove the "description": "{description*}" element.


"details" element


Field NameDescription
name
(Required)
Name of tag to be created.  
description
Optional description of tag being created.


Successful Response:


"response" element


Field NameDescription
statusWill return SUCCESS if tag was successfully created
dataTag Id, username of creator, description and create / update date.


Unsuccessful Response:


"response" element


Field NameDescription
statusWill return FAILED if unsuccessful
errormessageText explaining why request failed