Segmentation API

Note: Every call made to the v2 API’s must be made via the signed URL process. Any request without a valid signature will be rejected.

Creating a segment

This method is used to create a segment within the Koupon Media system. The segment name is included within the path of the URL and the actual consumers that are to be included in the segment are included within the POST body.

It is highly recommended that you are registering consumers within a segment under their “primary” identifier, as other identifiers are not guaranteed to be unique

POSThttp://oob.kouponmedia.com/v2/segment/segment_name

POST Body Options

Parameter Required/Optional Description
primary required A comma-separated array of all primary customer identifiers that should be included within that segment.

Example Response

    
{
  "code": 200,
  "message": "success",
  "version": "2",
}
    

Getting consumers within a segment

To retrieve all recorded consumers within a specific segment.

GEThttp://oob.kouponmedia.com/v2/segment/segment_name

Example Response

    
{
  "code": 200,
  "message": "success",
  "version": "2",
  "primary": ["email@example.com", "jeff@example.com"]
}
    

Updating consumers within a segment

To update the the primary identifiers that are within a specific consumer. This method must only be used for adding consumers to a segment, and the deletion of consumers must occur through the DELETE resource

PUThttp://oob.kouponmedia.com/v2/segment/segment_name

PUT Body Options

Parameter Required/Optional Description
primary optional A comma-separated array of all primary customer identifiers that should be added to an already created segment name.

Example Response

    
{
  "code": 200,
  "message": "success",
  "version": "2",
}
    

Deleting consumers within a segment

To delete the the primary identifiers that are within a specific consumer. This method must only be used for deleting consumers within a segment, and the addition of consumers must occur through the PUT resource

DELETEhttp://oob.kouponmedia.com/v2/segment/segment_name

DELETE Body Options

Parameter Required/Optional Description
primary optional A comma-separated array of all primary customer identifiers that should be deleted from an already created segment name.

Example Response

    
{
  "code": 200,
  "message": "success",
  "version": "2",
}