MPZ API > List Forms

Use the API to obtain a list of all user created signup forms in an account.

Request

Submit an XML Request with the following details:
Post URL: https://mpzmail.com/api/v3.0/forms/listForms/
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.
formCnt Int The number of forms that have been returned.
forms    
---> form    
--------> formID String The ID of the form.
--------> groupID Int The ID of the group that is set to receive subscribers from this form.
--------> dateCreated Date Time The date the form was created.
--------> formTitle String The friendly name of the Form.
--------> formHTML String The HTML of the javascript linking to the form.
--------> impressions Int The number of times the form has been viewed.
--------> signups Int The number of registrations the form has received.
--------> formType Int The type of form.
2 = Hosted Form.
3 = Embedded Form.
4 = Popup Form.

Sample request XML

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

Sample response XML

<xml>
     <formCnt>1</formCnt>
     <forms>
          <form>
               <formID>3403</formID>
               <groupID>412</groupID>
               <dateCreated>2016-6-19 16:33</dateCreated>
               <formTitle>Facebook Form</formTitle>
               <formHTML><![CDATA[http://forms.mpmailserv.co.uk/?fid=525-412-3403]]></formHTML>
               <impressions>234</impressions>
               <signups>8</signups>
               <formType>2</formType>
          </form>
     </forms>
</xml>

Comments