MPZ API > List Segments

Use the API to obtain a list of all segments in a group.

Request

Submit an XML Request with the following details:
Post URL: https://mpzmail.com/api/v3.0/groups/listSegments/
Fields to Post
apiKey String REQUIRED The APIKey of the requesting user.
groupID Int REQUIRED The ID of the group containing segments.

Response

Data Sent Back
error Int Indicated wether an error has occured. 0 for no error. 1 for error.
status String If there's been an error, a text description of the error that occured will be here.
segmentCnt Int The number of segments that have been returned.
segments    
---> segment    
--------> segmentID Int The ID of the Segment.
--------> segmentName String The friendly name of the segment.

Sample request XML

<xml>
     <apiKey>44-121312131223</apiKey>
     <groupID>12331</apiKey>
</xml>

Sample response XML

<xml>
     <error>0</error>
     <status>Success</status>
     <segmentCnt>2</segmentCnt>
     <segments>
          <segment>
               <segmentID>122</segmentID>
               <segmentName>Test Segment 1</segmentName>
          </segment>
          <segment>
               <segmentID>123</segmentID>
               <segmentName>Test Segment 2</segmentName>
          </segment>
     </segments>
</xml>

Comments