API
Aanmaken
Dit voorbeeld laat zien hoe je een HTML en/of Tekst nieuwsbrief kunt aanmaken door middel van de API.
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 | |
details.name | string | De naam van de nieuwsbrief. | Verplicht |
details.format | string | Het format. Dit kan zijn, h (van HTML), t (van Tekst/plain text) of b (van Beide). Het beste is b, maar dan dien je wel zowel een tekst als HTML versie in te schieten. | Verplicht |
details.subject | string | Het onderwerp van de nieuwsbrief. Niet meer dan 50 karakters. | Verplicht |
details.textbody | string | De content van de nieuwsbrief in plain text format. | Verplicht |
details.htmlbody | string | De content van de nieuwsbrief in HTML format. Vergeet niet de CDATA-tag toe te voegen | Verplicht |
details.createdate | int | Vul de datum in als unix timestamp. | Verplicht |
details.active | boolean | Gebruik de waarde 1 om de nieuwsbrief als actief in te schieten. 0 is inactief. | Verplicht |
details.archive | boolean | Gebruik de waarde 1 om de nieuwsbrief aan het nieuwsbrief archief toe te voegen. | Verplicht |
details.ownerid | int | Zet hier de ID van de user in voor wie de nieuwsbrief zichtbaar moet zijn in MailCamp. | Verplicht |
Succesvolle response
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
data | int | Het ID nummer van de nieuwsbrief. |
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>newsletters</requesttype>
<requestmethod>Create</requestmethod>
<responsetype>xml</responsetype>
<details>
<name>Nieuwsbrief #1 2019</name>
<format>b</format>
<subject>dit is het onderwerp van de nieuwsbrief</subject>
<textbody>Dit is de text body</textbody>
<htmlbody><![CDATA[
<html><head></head><body>Dit is de html body</body>
]]></htmlbody>
<createdate>1356994800</createdate>
<active>1</active>
<archive>1</archive>
<ownerid>99</ownerid>
</details>
</xmlrequest>