GET /api/recurring-email-receivers?recurring_id={recurring_id}
E-Mail-Empfänger können immer nur für eine bestimmte Abo-Rechnung zurückgegeben werden.
Deshalb ist recurring_id ein Pflichtparameter.
<!--?xml version="1.0" encoding="UTF-8"?--> <recurring-email-receivers type="array" page="1" per_page="100" total="2"> <recurring-email-receiver> ... <recurring-email-receiver> <recurring-email-receiver> ... <recurring-email-receiver> </recurring-email-receiver></recurring-email-receiver></recurring-email-receiver></recurring-email-receiver></recurring-email-receivers>
GET /api/recurring-email-receivers/{id}
<!--?xml version="1.0" encoding="UTF-8"?--> <recurring-email-receiver> <id type="integer">1</id> <recurring_id type="integer">1</recurring_id> <type>To</type></recurring-email-receiver> <address>info@example.com</address>
type kann folgende Werte haben:
– to
– cc
– bcc
POST /api/recurring-email-receivers
XML-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
---|---|---|---|---|
recurring_id | ID der Abo-Rechnung | INT | ja (nicht aber bei der Abo-Rechnungserstellung) | |
type | Empfänger-Typ (to, cc, bcc) | ALNUM | ||
address | E-Mail-Adresse | ALNUM | Wenn die Adresse leer gelassen wird, wird an die Kunden-Adresse verschickt. |
Der Empfänger wird zu bereits bereits vorhandenen Empfängern hinzugefügt.
<recurring-email-receiver> <recurring_id type="integer">1</recurring_id> <type>To</type></recurring-email-receiver> <address>info@example.com</address>
<!--?xml version="1.0" encoding="UTF-8"?--> <recurring-email-receiver> <id type="integer">1</id> <recurring_id type="integer">1</recurring_id> <type>To</type></recurring-email-receiver> <address>info@example.com</address>
PUT /api/recurring-email-receivers/{id}
Hier gelten die selben Parameter wie beim Anlegen, allerdings kann die verknüpfte Abo-Rechnung (recurring_id) nicht mehr geändert werden.
<recurring-email-receiver> <type>Bcc</type></recurring-email-receiver> <address>info@example.com</address>
DELETE /api/recurring-email-receivers/{id}