Returns Segment ID number and Segment name for one Segment mailing list.
JSON Request Example:
/**
* Users::FindSegment
*/
{
"username": "bob,
"usertoken": "def789",
"requesttype": "Users",
"requestmethod": "FindSegment",
"details": {
/* one of segment or name is required */
"segment": "{*segment_id*}",
"name": "{*segment_name*}"
}
}
"json_request" element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Users |
| requestmethod | FindSegment |
Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call. For example, if "segment" element is used, "segmentname": "{*segmentname*}" should be deleted.
"details" element
| Field Name | Description |
| segment (Required if "name" element not used) | Find the segment mailing list with this segment ID number. |
| name (Required if "segment" element not used) | Find the segment mailing list with this segment name. |
NOTE: This API call supports wildcard characters when providing the "segmentname" property value.
User may include a "*" or "%" character in the segmentname value to search for segment IDs.
Ex:
abc* will return all segments whose segmentname starts with abc
*abc will return all segments whose segmentname ends with abc
*abc* will return all segments whose segmentname has abc anywhere in the name
abc*xyz will return all segments whose segmentname 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 segment ID and name |
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return ERROR when unsuccessful |
| errormessage | Text explaining why request failed |