API
Mailinglijst aanmaken
Dit voorbeeld laat zien hoe je een mailinglijst 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 mailinglijst. | Verplicht |
details.owneremail | string | Het afzendadres van de mailinglijst. | Verplicht |
details.ownername | string | Het afzendnaam van de mailinglijst. | Verplicht |
details.bounceemail | string | Het bounceadres van de mailinglijst. | Verplicht |
details.replytoemail | string | Het replyto-adres van de mailinglijst. | Verplicht |
details.createdate | string | De aanmaakdatum van de mailinglijst. | Verplicht |
details.listconfirmed | tinyint | De bevestigings-status van een mailinglijst. 1 is bevestigd. Default: 0. | Verplicht |
details.notifyowner | tinyint | Eigenaar inlichten indien iemand zich in of uitschrijft. Default: 1. | Verplicht |
details.imapaccount | tinyint | Het bounce-adres is een IMAP account. Default: 1. | Verplicht |
details.bounceserver | string | De hostnaam van het bounce-adres. | Verplicht |
details.bounceusername | string | De gebruikersnaam van het bounce-adres. | Verplicht |
details.bouncepassword | string | Het wachtwoord van het bounce-adres. | Verplicht |
details.extramailsettings | string | Extra mail instellingen. Opties: '/novalidate-cert', '/notls', '/nossl'. Standaard: '/notls' | Verplicht |
details.companyname | string | Bedrijfsnaam. Deze informatie komt in de vCard waarnaar gelinkt kan worden in de nieuwsbrief. | Optioneel |
details.companyaddress | string | Bedrijfsadres. Deze informatie komt in de vCard waarnaar gelinkt kan worden in de nieuwsbrief. | Optioneel |
details.companyphone | string | Telefoonnummer. Deze informatie komt in de vCard waarnaar gelinkt kan worden in de nieuwsbrief. | Optioneel |
details.ownerid | int | Het gebruikers ID van de eigenaar van de mailinglijst. | Verplicht |
details.subscribecount | int | Het totaal aantal actieve en bevestigde contactpersonen op de mailinglijst. Default: 0 | Optioneel |
details.unsubscribecount | int | Het totaal aantal uitgeschreven contactpersonen op de mailinglijst. Default: 0 | Optioneel |
details.agreedelete | boolean | De in de mailbox gevonden gebouncede adressen worden verwijderd na het verwerken. | Verplicht |
details.agreedeleteall | boolean | Alle adressen worden verwijderd uit de mailbox na het verwerken. | Verplicht |
details.visiblefields | string | Komma-gescheiden standaard velden én ID's van extra velden die in het overzicht van de contactpersonen zichtbaar moeten zijn. | Verplicht |
details.customfields | string | Komma-gescheiden ID's van extra velden die gekoppeld moeten worden aan de mailinglijst. | Verplicht |
Succesvolle response
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
data | int | Indien de statistieken worden gevonden wordt het object teruggegeven. |
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>lists</requesttype>
<requestmethod>Create</requestmethod>
<responsetype>xml</responsetype>
<details>
<name>Mailinglijst</name>
<owneremail>info@mailcamp.nl</owneremail>
<ownername>MailCamp B.V.</ownername>
<bounceemail>bounce@mailcamp.nl</bounceemail>
<replytoemail>antwoord@mailcamp.nl</replytoemail>
<createdate>1483228800</createdate>
<listconfirmed>1</listconfirmed>
<notifyowner>1</notifyowner>
<imapaccount>1</imapaccount>
<bounceserver>mail.domein.nl:993</bounceserver>
<bounceusername>bounce@mailcamp.nl</bounceusername>
<bouncepassword>W@chtw00rd</bouncepassword>
<extramailsettings>/novalidate-cert/ssl</extramailsettings>
<companyname>MailCamp B.V.</companyname>
<companyaddress>Amsterdamsevaart 26</companyaddress>
<companyphone>020-7058500</companyphone>
<ownerid>99</ownerid>
<subscribecount>0</subscribecount>
<unsubscribecount>0</unsubscribecount>
<processbounce>1</processbounce>
<agreedelete>1</agreedelete>
<agreedeleteall>1</agreedeleteall>
<visiblefields>emailaddress,subscribedate,updated,status,confirmed,2,4</visiblefields>
<customfields>2,3,4,5</customfields>
</details>
</xmlrequest>