Returns Tag ID number and tag name for one tag mailing list.
JSON Request Example:
"json_request" element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Tag |
requestmethod | FindTag |
Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call. For example, if "tag" element is used, "tagname": "{*tagname*}" should be deleted.
"details" element
Field Name | Description |
tag (Required if "name" element not used) | Find the tag mailing list with this ID number. |
tagname (Required if "tag" element not used) | Find the tag mailing list with this name. |
NOTE: This API call supports wildcard characters when providing the "tagname" property value.
User may include a "*" or "%" character in the tagname value to search for tag IDs.
Ex:
abc*
will return all tags whose tagname starts with abc
*abc
will return all tags whose tagname ends with abc
*abc*
will return all tags whose tagname has abc
anywhere in the name
abc*xyz
will return all tags whose tagname starts with abc
and also ends with xyz
User may also use the wildcard characters "_" and "?" to search for a single character.
Successful Response:
"response" element
Field Name | Description |
status | Will return SUCCESS if tag was successfully found |
data | The tag ID and name |
Unsuccessful Response:
"response" element
Field Name | Description |
status | Will return ERROR when unsuccessful |
errormessage | Text explaining why request failed |