Welcome‎ > ‎Version 2‎ > ‎Publisher Api (Read/Write)‎ > ‎Data Structures‎ > ‎

Offer Segment

Segment data as it pertains to an offer.

Fields:
  externalRefId - The external id of the segment (defined by the publisher).
  name - The segment name.
  key - The segment key.  This is required for POST operation on the offer.

Sample XML Response:
<segment>
    <externalRefId>1</externalRefId>
    <name>New York</name>
    <key>new-york</name>
</segment>

Sample JSON Response:

{
    "segment": {
        "externalRefId":"1",
        "name": "New York",
        "key": "new-york"
    }
}
Comments