API
Contact exists
This example shows whether an email address exists in a specific mailing list.
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.emailaddress | string | The email address of the contact being searched for | Required |
details.listids | int | The ID of the mailing list being searched | Required |
details.subscriberid | int | The ID of the contact being searched for | Optional |
details.activeonly | string | Check for active contacts only, or also for bounced email addresses or unsubscribed contacts | Optional |
details.not_bounced | string | Check for contacts that do not have the status bounced | Optional |
details.return_listid | int | Returns the ID of the mailing list in the result | Optional |
Successful response
| Field | Type | Description |
|---|---|---|
status | string | The value of the status field is returned as “SUCCESS” on a successful response. |
data | If the statistics are found, the object is returned. |
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. |
<xmlrequest>
<username>admin</username>
<usertoken>0123456789abcdef0123456789abcdef01234567</usertoken>
<requesttype>subscribers</requesttype>
<requestmethod>IsSubscriberOnList</requestmethod>
<responsetype>xml</responsetype>
<details>
<emailaddress>email@mailcamp.nl</emailaddress>
<listids>99</listids>
<subscriberid />
<activeonly />
<not_bounced />
<return_listid />
</details>
</xmlrequest>