MPZ API > Add Subscribers

Use the API to add OR update a subscriber or multiple subscribers.

Request

Submit an XML Request with the following details:
Post URL: https://mpzmail.com/api/v3.0/subscribers/addSubscribers/
Fields to Post
apiKey String REQUIRED The APIKey of the requesting user.
groupID Int REQUIRED The ID of the group you would like to add subscribers to.
returnAllFields String   Optional. If set to 1, all fields including custom fields are returned in the response.
subscribers      
---> subscriber      
------> email String REQUIRED The email address of the new subscriber. Must be valid and not blank.
------> firstName String   The first name of the new subscriber.
------> lastName String   The last name of the new subscriber.
------> companyName String   The company name of the new subscriber.
------> customField1 String   Custom Field
------> customField2 String   Custom Field
------> customField3 String   Custom Field
------> customField4 String   Custom Field
------> customField5 String   Custom Field
------> customField6 String   Custom Field
------> customField7 String   Custom Field
------> customField8 String   Custom Field
------> customField9 String   Custom Field
------> customField10 String   Custom Field
------> houseNo String   House Number
------> address1 String   Address 1
------> address2 String   Address 2
------> town String   Town
------> county String   The county or state
------> country String   Country
------> postCode String   Post or Zip Code
------> isActive Int   0 = Active, 1 = InActive

Response

Data Sent Back
error Int Indicates 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.
subscribers    
---> subscriber    
--------> error Int Indicates wether an error occured adding this subscriber. 0 for no error, 1 for error.
--------> status String If there's been an error adding this subscriber, a text description of the error that occured will be here.
--------> subscriberID Int If the subscriber added or updated succesfully, their new subscriber ID appears here.
--------> email String The email address of the subscriber.

Sample request XML

<xml>
     <apiKey>44-121312131223</apiKey>
     <groupID>123</groupID>
     <subscribers>
          <subscriber>
               <email>test@test.com</email>
               <firstName>Test</firstName>
               <lastName>User</lastName>
               <companyName>Test Company</companyName>
          </subscriber>
          <subscriber>
               <email>test2@test.com</email>
               <firstName>Test2</firstName>
               <lastName>User2</lastName>
               <companyName>Test2 Company</companyName>
          </subscriber>
     </subscribers>
</xml>

Sample response XML

<xml>
     <error>0</error>
     <status>success</status>
     <subscribers>
          <subscriber>
               <error>0</error>
               <status>success</status>
               <subscriberID>12314</subscriberID>
               <email>test@test.com</email>
          </subscriber>
          <subscriber>
               <error>0</error>
               <status>success</status>
               <subscriberID>12315</subscriberID>
               <email>test2@test2.com</email>
          </subscriber>
     </subscribers>
</xml>

Comments