API
Contactpersoon toevoegen aan de geweigerde lijst
Dit voorbeeld laat zien hoe je een contactpersoon kan toevoegen aan de 'geweigerde e-maillijst' ofwel de suppressielijst. Op de suppressielijst staan contactpersonen die nooit mailings mogen ontvangen ongeacht de status van deze contactpersonen in de mailinglijsten.
Parameters
| Veld | Type | Omschrijving | Verplicht / Optioneel |
|---|---|---|---|
username | string | De gebruikersnaam wordt gebruikt om in te loggen op de MailCamp. | Verplicht |
usertoken | string | De unieke token toegewezen aan de hierboven genoemde gebruiker. | Verplicht |
requesttype | string | De naam van het betreffende API-bestand. | Verplicht |
requestmethod | string | De naam van de functie die wordt aangeroepen. | Verplicht |
responsetype | string | Het format van de response. Dit kan zijn 'xml' of 'json'. | Optioneel |
details | Zie de velden hieronder. | Verplicht | |
emailaddress | string | Het e-mailadres van de contactpersoon die u wilt toevoegen aan de geweigerde email-lijst/suppressielijst | Verplicht |
listid | int | Het ID van de mailinglijst. Indien u deze niet opgeeft zal het voor alle mailinglijsten gelden. | Verplicht |
Succesvolle response
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
Foutmelding
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld zal “FAILED” zijn. |
errormessage | string | Een tekstuele boodschap om uit te leggen waarom het verzoek is mislukt. |
<xmlrequest>
<username>admin</username>
<usertoken>0123456789abcdef0123456789abcdef01234567</usertoken>
<requesttype>subscribers</requesttype>
<requestmethod>AddBannedSubscriber</requestmethod>
<responsetype>xml</responsetype>
<details>
<emailaddress>email@mailcamp.nl</emailaddress>
<listid>99</listid>
</details>
</xmlrequest>