eyepin Documentation

Last Update: 2024-03-21

Newsletter Insert

Request:

<?xml version="1.0" encoding="utf-8"?>
<newsletter-insert id="" externalid="">

    <title></title>
    <titleinternal></titleinternal>

    <!-- Settings //-->
    <template id="" />
    <snipplets></snipplets>
    <language>de</language>
 
    <!-- Header fields //-->
    <fromemail></fromemail>
    <fromname></fromname>
    <replyto></replyto>
    <subject></subject>

    <!-- Newsletter fields (needs to be defined in used template) //-->
    <preheader></preheader>
    <salutation id="" use-individual="1" />
    <header></header>
    <headerpicture id="" />
    <footer></footer>
    <footerpicture id="" />
    <custom1></custom1>
    ...
    <custom10></custom10>

    <!-- Variant A) List of articles without groups //-->
    <arealist>
        <area num="">
            <contentlist>
                <content id1="" externalid1="" source1="" filterid="" id2="" externalid2="" source2="" />
                ...
            </contentlist>
        </area>
        ...
    </arealist>

    <!-- Variant B) List of articles with groups //-->
    <arealist>
        <area num="">
            <group num="">
                <name></name>
                <contentlist>
                    <content id1="" externalid1="" source1="" filterid="" id2="" externalid2="" source2="" />
                    ...
                 </contentlist>
            </group>
            ...
        </area>
        ...
    </arealist>

</newsletter-insert>

Description of XML-Tags:

Element	Format	Description
`externalid`	varchar(255)	Optional and only on Insert; External ID of the newsletter
`title`	text	Title
`titleinternal`	varchar(255)	Internal title
`template/@id`	int	Id of layout
`snipplets`	1,2,3,...	If used layout supports snipplets, this is the comma separated list of numbers of the snipplets to show.
`language`	2-letter code	Example: "de" or "en"
`fromemail`	varchar(255)	"Standard", "AccountManager" or individual email address with an allowed domain
`fromname`	varchar(255)
`replyto`	varchar(255)	Email address
`subject`	varchar(255)
`preheader`	text	Preheader
`salutation`		Salutation
`↳ @id`	int	ID of salutation
`↳ @use-individual`	0\|1	If "1" the contacts individual salutation will be shown if it has one defined
`header`	longtext	Header (editorial)
`headerpicture`	int	ID of header picture
`footer`	text	Footer
`footerpicture`	int	ID of footer picture
`custom1..10`	text	Up to 10 custom fields (need to be defined in used template)
`arealist`		List of content areas. On update the whole list will be replaced!
`↳ area`		Content area
`↳ @num`	int	Index number of content area
`↳ group`		A group of contents within the area
`↳ name`		Name of group
`↳ contentlist`		Contains list of content relations
`↳ content`		Content
`↳ @id1`	int	ID of content
`↳ @externalid1`	varchar(255)	External ID of content (overrules "id1")
`↳ @source1`	selection	Source of content. Available sources: Content\|Event\|Form\|Survey\|Sweepstake
`↳ @filterid`	int	ID of address of (smart) list. If the contact is n the the list, then the first content will be shown, otherwise the alternative second one.
`↳ @id2`	int	ID of alternative content
`↳ @externalid2`	varchar(255)	External ID of alternative content (overrules "id2")
`↳ @source2`	selection	Source of alternative content. Available sources: Content\|Event\|Form\|Survey\|Sweepstake

Response:

On success the internal ID of the newsletter will be returned in response->data.

Für Rückfragen stehen wir Ihnen jederzeit gerne unter support@eyepin.com zur Verfügung.