MPZ API > List Groups

Use the API to obtain a list of all groups in an account.

Request

Submit an XML Request with the following details:
Post URL: https://mpzmail.com/api/v3.0/groups/listGroups/
Fields to Post
apiKey String REQUIRED The APIKey of the requesting user.

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.
groupCnt Int The number of groups that have been returned.
groups    
---> group    
--------> groupName String The friendly name of the group.
--------> groupID Int The ID of the group.
--------> subscribers Int The number of subscribers in the group.
--------> dateCreated Date Time The date the group was created.

Sample request XML

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

Sample response XML

<xml>
     <error>0</error>
     <status>Success</status>
     <groupCnt>2</groupCnt>
     <groups>
          <group>
               <groupName>Test Group 1</groupName>
               <groupID>123</groupID>
               <subscribers>1321</subscribers>
               <dateCreated>2014-03-01 11:00</dateCreated>
          </group>
          <group>
               <groupName>Test Group 2</groupName>
               <groupID>124</groupID>
               <subscribers>113</subscribers>
               <dateCreated>2014-05-03 12:01</dateCreated>
          </group>
     </groups>
</xml>

Comments