API
Unsubscribe contact
This example shows how to unsubscribe a contact from a 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.listid | int | The ID of the mailing list the contact is on | Required |
details.emailaddress | string | The email address of the contact you want to unsubscribe | Required |
Successful response
| Field | Type | Description |
|---|---|---|
status | string | The value of the status field is returned as “SUCCESS” on a successful response. |
data | If the contact was unsubscribed successfully, the subscriberid is returned. |
Error response
| Field | Type | Description |
|---|---|---|
status | string | The value of the status field will be “ERROR”. |
errormessage | string | A text message explaining why the request failed. |
<xmlrequest>
<username>admin</username>
<usertoken>0123456789abcdef0123456789abcdef01234567</usertoken>
<requesttype>subscribers</requesttype>
<requestmethod>UnsubscribeSubscriber</requestmethod>
<responsetype>xml</responsetype>
<details>
<emailaddress>email@mailcamp.nl</emailaddress>
<listid>99</listid>
<subscriberid />
</details>
</xmlrequest>