Creates a Segment. 


JSON Request Example:      


/**
 * Segments::CreateSegment
 *
 *  Create a segment
 *
 *  segmentname     [string, required]: segment name
 *  ruleset         [object, required]: operator + list of rules
 *    op            [and|or, required]: rule combining operator
 *    rules         [array, required]: list of rules
 *      field       [string, required]: field name
 *      op          [string, required]: comparison/condition operator
 *      value       [string, required*]: comparison/condition value
 *  lists           [array, required]: list id(s)
 */
{
  "username": "bob", /* Email or username used for authentication */
  "usertoken": "123abc", /* API token for authentication */
  "requesttype": "Segments", 
  "requestmethod": "CreateSegment", 
  "details": {
    "segmentname": "{*segment_name*}", /* Name of the segment */
    "ruleset": {
      "op": "{*AND or OR*}", /* Logical operator for combining rules */
      "rules": [
         /* required: at least one */
        {
          "field": "{*field_name*}", /* Field to evaluate (e.g., \"email\", \"name\") */
          "op": "{*equals, starts_with, etc.*}", /* Condition to apply (refer to supported operators) */
          "value": "{*value_to_compare*}" /* Value to compare against */
        },
        /* ... Additional rules can be added here */
          /* ... use this for nested/grouped rules. */
        {
          "op": "{*AND or OR*}", /* Logical operator for nested rules */
          "rules": [
            /* ... Nested rules can be added here */
          ]
        }
      ]
    },
    "lists": [ /* required: at least one list.  */
      {*list_id1*},
      {*list_id2*},
      /* ... Additional list IDs can be added here */
    ]
  }
}
Null

"json_request"  element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeSegments
requestmethodFindSegment


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 NameDescription
segmentname
(Required)
Give a name to your new segment 
ruleset
(required) 
op (AND or OR)
rules (list of rules) (at least ONE of field, op, values required)
field (the field to evaluate)
op (equals, starts with, etc.)
value (value to compare against) 
lists
(required) 
listid 


Successful Response:


"response" element


Field NameDescription
statusWill return SUCCESS if tag was successfully found
dataThe segment ID and name


Unsuccessful Response:


"response" element


Field NameDescription
statusWill return ERROR when unsuccessful
errormessage

Text explaining why request failed