API

Contact custom fields

This example returns an XML with the custom field data and tags of one specific contact on a given mailing list.

Parameters

Parameters
Field	Type	Description	Required / Optional
`username`	string	The username used to log in to MailCamp.	Required
`usertoken`	string	The unique token assigned to the user named above.	Required
`requesttype`	string	The name of the relevant API file.	Required
`requestmethod`	string	The name of the function being called.	Required
`responsetype`	string	The format of the response. This can be 'xml' or 'json'.	Optional
`details`		See the fields below.	Required
details.`subscriberid`	int	The ID of the contact.	Required
details.`listid`	int	The ID of the mailing list the contact is on.	Required
details.`activeonly`	string	Indicates whether to search active contacts only. Default: false.	Optional
details.`include_customfields`	string	Indicates whether the custom field data must also be returned. Default: true.	Optional
details.`include_tags`	string	Indicates whether the tags must also be returned. Default: true.	Optional
details.`include_bouncedetails`	string	Indicates whether the bounce data must also be returned. Default: false.	Optional

Successful response

Successful response
Field	Type	Description
`status`	string	The value of the status field is returned as “SUCCESS” on a successful response.

Error response

Error response
Field	Type	Description
`status`	string	The value of the status field will be “FAILED”.
`errormessage`	string	A text message explaining why the request failed.

Request example:

PHP request example

Response Success

Response Failed

Request example:

<xmlrequest>
	<username>admin</username>
	<usertoken>0123456789abcdef0123456789abcdef01234567</usertoken>
	<requesttype>subscribers</requesttype>
	<requestmethod>LoadSubscriberList</requestmethod>
	<responsetype>xml</responsetype>
	<details>
		<subscriberid>99</subscriberid>
		<listid>99</listid>
		<activeonly>false</activeonly>
		<include_customfields>true</include_customfields>
		<include_tags>true</include_tags>
		<include_bouncedetails>false</include_bouncedetails>
	</details>
</xmlrequest>