API

Token check

This example checks whether the token you are using is valid.

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

Successful response

Successful response
Field	Type	Description
`status`	string	The value of the status field is returned as “SUCCESS” on a successful response.
`data`	int	This will be ‘1’ on successful authorization.

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>authentication</requesttype>
	<requestmethod>xmlapitest</requestmethod>
	<responsetype>xml</responsetype>
	<details>
	</details>
</xmlrequest>