API

Contactpersoon toevoegen

Een contactpersoon kan met de onderstaande XML-structuur worden toegevoegd. Het is ook mogelijk om tot 100 contacten in één call toe te voegen. De contactpersooninformatie moet dan binnen de <contact> tag worden gestuurd. Er kunnen dus meerdere contact-tags in één en dezelfde call onder elkaar worden geplaatst.

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.mailinglistint

Het ID van de mailinglijst waaraan de contactpersoon moet worden toegevoegd.

Verplicht
details.contactstring

Indien er meer dan één contactpersoon moet worden toegevoegd kun je de contactpersooninformatie binnen een contact-tag plaatsen en hier meerdere van onder elkaar plaatsen (tot 100 contacten per call).

Optioneel
details.emailaddressstring

Het e-mailadres van de contactpersoon die wordt toegevoegd.

Verplicht
details.confirmedboolean

Zet de bevestigingsstatus van de contactpersoon op bevestigd of niet (yes of y of true of 1)

Optioneel
details.ipaddressint

Het IP adres van de gebruiker op het moment van aanmelden.

Optioneel
details.subscribedateint

Vul de inschrijfdatum in als unix timestamp.

Optioneel
details.lastopenint

Vul de datum 'laatst geopende nieuwsbrief' in als unix timestamp.

Optioneel
details.add_to_autorespondersstring

Of autoresponders die zijn aangemaakt voor de betreffende mailinglijst moet worden verzonden naar deze contactpersoon. Gebruik true of false. Default: true

Optioneel
details.add_to_autoresponders.fieldidint

Het ID van het extra veld dat dient te worden toegevoegd.

Verplicht
details.add_to_autoresponders.fieldid.valuestring

De waarde die aan het extra veld moet worden toegekend. In het geval van een checkbox kunnen het meerdere values zijn. Let erop dat indien een value een &-teken heeft dat er CDATA en urlencoding() gebruikt moet worden.

Verplicht
tagidint

Het ID van de tag die dient te worden toegevoegd.

Optioneel
tagnamestring

De naam van de tag die dient te worden toegevoegd.

Optioneel

Succesvolle response

Succesvolle response
VeldTypeOmschrijving
statusstring

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

data

Indien de statistieken worden gevonden wordt het object teruggegeven.

Request voorbeeld
<xmlrequest>
	<username>admin</username>
	<usertoken>0123456789abcdef0123456789abcdef01234567</usertoken>
	<requesttype>subscribers</requesttype>
	<requestmethod>AddSubscriberToList</requestmethod>
	<responsetype>xml</responsetype>
	<details>
		<mailinglist>99</mailinglist>
		<contact>
			<emailaddress>email@mailcamp.nl</emailaddress>
			<confirmed>yes</confirmed>
			<ipaddress>203.0.113.10</ipaddress>
			<subscribedate>1483228800</subscribedate>
			<lastopen>1483228800</lastopen>
			<add_to_autoresponders>false</add_to_autoresponders>
			<customfields>
				<item>
					<fieldid>99</fieldid>
					<value>Jan Jansen</value>
				</item>
				<item>
					<fieldid>99</fieldid>
					<value><![CDATA[Eten %26 Drinken]]></value>
					<value><![CDATA[Sport]]></value>
					<value>Jan Jansen</value>
				</item>
				<item>
					<fieldid>99</fieldid>
					<value>31/01/1980</value>
				</item>
			</customfields>
			<tags>
				<tagid>99</tagid>
				<tagid>99</tagid>
				<tagname><![CDATA[Prospect]]></tagname>
				<tagname><![CDATA[Lead]]></tagname>
			</tags>
		</contact>
	</details>
</xmlrequest>