API

Mailinglijst aanmaken

Dit voorbeeld laat zien hoe je een mailinglijst kunt aanmaken door middel van de API.

Parameters

Parameters
VeldTypeOmschrijvingVerplicht / Optioneel
usernamestring

De gebruikersnaam wordt gebruikt om in te loggen op de MailCamp.

Verplicht
usertokenstring

De unieke token toegewezen aan de hierboven genoemde gebruiker.

Verplicht
requesttypestring

De naam van het betreffende API-bestand.

Verplicht
requestmethodstring

De naam van de functie die wordt aangeroepen.

Verplicht
responsetypestring

Het format van de response. Dit kan zijn 'xml' of 'json'.

Optioneel
details

Zie de velden hieronder.

Verplicht
details.namestring

De naam van de mailinglijst.

Verplicht
details.owneremailstring

Het afzendadres van de mailinglijst.

Verplicht
details.ownernamestring

Het afzendnaam van de mailinglijst.

Verplicht
details.bounceemailstring

Het bounceadres van de mailinglijst.

Verplicht
details.replytoemailstring

Het replyto-adres van de mailinglijst.

Verplicht
details.createdatestring

De aanmaakdatum van de mailinglijst.

Verplicht
details.listconfirmedtinyint

De bevestigings-status van een mailinglijst. 1 is bevestigd. Default: 0.

Verplicht
details.notifyownertinyint

Eigenaar inlichten indien iemand zich in of uitschrijft. Default: 1.

Verplicht
details.imapaccounttinyint

Het bounce-adres is een IMAP account. Default: 1.

Verplicht
details.bounceserverstring

De hostnaam van het bounce-adres.

Verplicht
details.bounceusernamestring

De gebruikersnaam van het bounce-adres.

Verplicht
details.bouncepasswordstring

Het wachtwoord van het bounce-adres.

Verplicht
details.extramailsettingsstring

Extra mail instellingen. Opties: '/novalidate-cert', '/notls', '/nossl'. Standaard: '/notls'

Verplicht
details.companynamestring

Bedrijfsnaam. Deze informatie komt in de vCard waarnaar gelinkt kan worden in de nieuwsbrief.

Optioneel
details.companyaddressstring

Bedrijfsadres. Deze informatie komt in de vCard waarnaar gelinkt kan worden in de nieuwsbrief.

Optioneel
details.companyphonestring

Telefoonnummer. Deze informatie komt in de vCard waarnaar gelinkt kan worden in de nieuwsbrief.

Optioneel
details.owneridint

Het gebruikers ID van de eigenaar van de mailinglijst.

Verplicht
details.subscribecountint

Het totaal aantal actieve en bevestigde contactpersonen op de mailinglijst. Default: 0

Optioneel
details.unsubscribecountint

Het totaal aantal uitgeschreven contactpersonen op de mailinglijst. Default: 0

Optioneel
details.agreedeleteboolean

De in de mailbox gevonden gebouncede adressen worden verwijderd na het verwerken.

Verplicht
details.agreedeleteallboolean

Alle adressen worden verwijderd uit de mailbox na het verwerken.

Verplicht
details.visiblefieldsstring

Komma-gescheiden standaard velden én ID's van extra velden die in het overzicht van de contactpersonen zichtbaar moeten zijn.

Verplicht
details.customfieldsstring

Komma-gescheiden ID's van extra velden die gekoppeld moeten worden aan de mailinglijst.

Verplicht

Succesvolle response

Succesvolle response
VeldTypeOmschrijving
statusstring

De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons.

dataint

Indien de statistieken worden gevonden wordt het object teruggegeven.

Foutmelding

Foutmelding
VeldTypeOmschrijving
statusstring

De waarde van het status-veld zal “FAILED” zijn.

errormessagestring

Een tekstuele boodschap om uit te leggen waarom het verzoek is mislukt.

Request voorbeeld
<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>