API

Contactpersoon verwijderen

Dit voorbeeld laat zien hoe u een contactpersoon verwijderd uit een mailinglijst.

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

Het ID van de mailinglijst waarop de contactpersoon staat

Verplicht
details.emailaddressstring

Het e-mailadres van de contactpersoon die u wilt verwijderen

Verplicht

Succesvolle response

Succesvolle response
VeldTypeOmschrijving
statusstring

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

data

Indien de contactpersoon met succes is verwijderd wordt het subscriberid teruggegeven.

Foutmelding

Foutmelding
VeldTypeOmschrijving
statusstring

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

errormessagestring

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

Request voorbeeld
<xmlrequest>
	<username>admin</username>
	<usertoken>0123456789abcdef0123456789abcdef01234567</usertoken>
	<requesttype>subscribers</requesttype>
	<requestmethod>DeleteSubscriber</requestmethod>
	<responsetype>xml</responsetype>
	<details>
		<emailaddress>email@mailcamp.nl</emailaddress>
		<listid>99</listid>
		<subscriberid />
	</details>
</xmlrequest>