Benötigen Sie Hilfe?
Im Maileon Help-Center finden Sie umfassende Dokumentationen zu unserem System.
Beliebte Suchanfragen: Importe | Rest-API | Integrationen | SMS
-
Maileon Anleitungen
-
-
- Bald verfügbar
-
-
-
- Bald verfügbar
-
-
- Bald verfügbar
-
- Bald verfügbar
-
-
-
- Bald verfügbar
-
- Bald verfügbar
-
- Bald verfügbar
-
-
-
-
-
- Bald verfügbar
-
FAQs
-
Grundlagen
-
Für Entwickler
-
-
- Adding Unsubscription Reason to Already Unsubscribed Contact
- Contacts
- Count Active Contacts By Filter ID
- Count Contacts By Filter ID
- Create Contact
- Create Contact (JSON)
- Create Contact by External ID
- Create Contact by External ID (JSON)
- Create Contact Preference
- Create Contact Preference Category
- Create Custom Field
- Custom Contact Fields
- Delete All Contacts
- Delete Contact By Maileon ID
- Delete Contact Preference
- Delete Contact Preference Category
- Delete Contacts By Email
- Delete Contacts By External ID
- Delete Custom Field
- Delete Custom Field Values
- Delete Standard Field Values
- Delete Unsubscription-Marker
- Get Blocked Contacts
- Get Contact By Email
- Get Contact By Maileon ID
- Get Contact Preference
- Get Contact Preference Categories
- Get Contact Preference Category by Name
- Get Contacts
- Get Contacts By Email
- Get Contacts By External Id
- Get Contacts By Filter Id
- Get Count Contacts
- Get Custom Fields
- Get Preferences of Contact Preferences Category
- Get Unsubscription-Marker
- Rename Custom Field
- Set Unsubscription-Marker
- Standard Contact Fields
- Synchronize Contacts
- Synchronize Contacts Error Codes
- Unsubscribe Contact By Maileon Id
- Unsubscribe Contacts By Email
- Unsubscribe Contacts by External Id
- Update Contact By Email
- Update Contact By External ID
- Update Contact By Maileon ID
- Update Contact Preference
- Update Contact Preference Category
- Alle Artikel anzeigen ( 34 ) Artikel zusammenklappen
-
- Get Blocks
- Get Bounces
- Get Clicks
- Get Conversions
- Get Filtered Contacts
- Get Opens
- Get Recipients
- Get Revenue
- Get Subscribers
- Get Unique Bounces
- Get Unique Clicks
- Get Unique Conversions
- Get Unique Opens
- Get Unsubscription Reasons
- Get Unsubscriptions
- Social Networks List
- Alle Artikel anzeigen ( 1 ) Artikel zusammenklappen
-
- Add Mailing Blacklist to Mailing
- Copy Mailing
- Create Dispatching
- Create Mailing
- Delete Mailing
- Delete Mailing Blacklist from Mailing
- Delete Trigger
- Get CMS2 Mailing As Zip
- Get Dispatching
- Get limit on number of contacts
- Get Mailing Archive URL
- Get Mailing Blacklists for Mailing
- Get Mailing ID By Name
- Get Mailing Report URL
- Get Mailing Thumbnail
- Get Mailing Thumbnail URL
- Get Mailings By Creator Name
- Get Mailings By Keywords
- Get Mailings By Schedule Time
- Get Mailings By States
- Get Mailings By Subject
- Get Mailings By Types
- Get Preview Text
- Get Template
- Get Templates for CMS2
- Get The Reply-To Address
- Mailing – Add Attachment
- Mailing – Add Custom Mailing Properties
- Mailing – Copy Attachments
- Mailing – Create Schedule
- Mailing – Delete Attachment
- Mailing – Delete Attachments
- Mailing – Delete Schedule
- Mailing – Disable QoS Checks
- Mailing – Enable Target Group Update
- Mailing – Fill RSS SmartMailing Tags
- Mailing – Get “Ignore Permission” State
- Mailing – Get “Post Sendout Cleanup” State
- Mailing – Get Archival Duration
- Mailing – Get Attachment
- Mailing – Get Attachments
- Mailing – Get Count Attachments
- Mailing – Get DOI Mailing Key
- Mailing – Get HTML
- Mailing – Get List of Custom Mailing Properties
- Mailing – Get Locale
- Mailing – Get Mailing Domain
- Mailing – Get Max Attachment Size
- Mailing – Get Max Content Size
- Mailing – Get Name
- Mailing – Get Recipient Alias
- Mailing – Get result for Link Quality Check
- Mailing – Get result for Message Size Quality Check
- Mailing – Get result for Personalization Quality Check
- Mailing – Get result for Spam Quality Check
- Mailing – Get results for Approval Sendout Quality Check
- Mailing – Get results for Attention Quality Check
- Mailing – Get results for Bounce Quality Check
- Mailing – Get results for Display Quality Check
- Mailing – Get results for Image Quality Check
- Mailing – Get results for Test Mail Sendout
- Mailing – Get Schedule
- Mailing – Get Sender Address
- Mailing – Get Sender Alias
- Mailing – Get Speed Level
- Mailing – Get State
- Mailing – Get Subject
- Mailing – Get Tags
- Mailing – Get Target Group Id
- Mailing – Get Target Group Update status
- Mailing – Get Text
- Mailing – Get Tracking Duration
- Mailing – Get Tracking Strategy
- Mailing – Get Type
- Mailing – Is Sealed
- Mailing – Remove Custom Mailing Property
- Mailing – Send Approval Mail to Targetgroup
- Mailing – Send Now
- Mailing – Send Testmail to Single Emailaddress
- Mailing – Send Testmail to Targetgroup
- Mailing – Set “Ignore Permission” State
- Mailing – Set “Post Sendout Cleanup” State
- Mailing – Set DOI Mailing Key
- Mailing – Set Html
- Mailing – Set Locale
- Mailing – Set Name
- Mailing – Set Recipient Alias
- Mailing – Set Sender Address
- Mailing – Set Sender Alias
- Mailing – Set Speed Level
- Mailing – Set Subject
- Mailing – Set Tags
- Mailing – Set Target Group Id
- Mailing – Set Text
- Mailing – Set Tracking Strategy
- Mailing – Start Attention Quality Check
- Mailing – Start Bounce Quality Check
- Mailing – Start Image Quality Check
- Mailing – Start Link Quality Check
- Mailing – Start Message Size Quality Check
- Mailing – Start Personalization Quality Check
- Mailing – Start Quality Check
- Mailing – Update Custom Mailing Property
- Mailing – Update Schedule
- Reset Contents to Template
- Save CMS2 Mailing to Media Library
- Set limit on number of contacts before sending mailing
- Set Preview Text
- Set Template
- Set Template for CMS2 Mailing
- Set The Reply-To Address
- Alle Artikel anzeigen ( 96 ) Artikel zusammenklappen
Create Contact by External ID
Sie sind hier:
Creates or updates a contact identified by its external ID and optionally triggers a double opt-in (doi) process. Note that none of the attributes is required, however, the body needs to provide a XML representation of the contact, in the easiest case an contact with only the ID given: <contact><email>max..mustermann@xqueue.com</email></contact>.Note: This method returns 409 (Conflict) if there are more then one contacts with the given external ID. In this case it is not possible to properly identify the contact any more. Change or remove them by identifying them with the unique Maileon ID or, if possible, by email.
POST https://api.maileon.com/1.0/contacts/externalid/:value
Attributes
Parameter | Default | Description |
permission | 1 | Specifies the initial permission to be assigned to the contact.Please note: this is the initial permission that is assigned to the contact as soon as it is created. If a double-opt-in process is triggered, the permission is changed to DOI or DOI+ after the contact used the acknowledgement link in the DOI mailing. If the same contact is registered again after already acknowledging the DOI link (and thus, already has Permission 4 or 5) and you call this method with any other permission then 4 or 5 (less valuable), the permission will be ignored, since you already own a valid DOI(+) permission. |
Further, if Permission 4 or 5 is already set and the account is set up not to send DOI mailings if there is already a DOI permission, no DOI mailing is triggered when creating the contact a second time. | ||
Supported values: | ||
1: none | ||
2: single opt-in | ||
3: confirmed opt-in | ||
4: double opt-in | ||
5: double opt-in plus | ||
6: other | ||
sync_mode | 2 | Specifies the synchronization option in case a contact with the provided email address already exists. |
Supported values: | ||
1: update (contact data will be updated) | ||
2: ignore (nothing will be done) | ||
src | A string intended to describe the source of the contact. If provided, the string will be stored with the doi process. | |
subscription_page | In case where this method was called by a subscription page, this string offers the possibility to keep track of it for use in reports. | |
doi | false | Tells whether a double opt-in process should be started for the created contact. Note that the status code returned for this request does not mean that the doi process succeeded. Supported values are true and false.
Notice: Please be aware that you can set up the behavior for (re-)sending DOI mails in your Maileon account under “Settings” -> “Lists & Contacts” -> „Contact Management“. Here you can define if a DOI mail should be sent to contacts not having finished the DOI process or contacts having a valid DOI permission already. |
doiplus | false | This parameter is ignored if doi is not provided or false. In case the doi process succeeds, Maileon will be allowed to track opens and clicks of the contact. |
doimailing | This parameter defines the DOI mailing key of the (active) DOI mailing to be used. Be aware, that this is not the ID of the DOI mail but the key that can be specified in the API or UI. It is ignored if doi is not provided or false. If not provided, the default doi mailing will be used. |
Example
POST https://api.maileon.com/1.0/contacts/externalid/baf52l?permission=1&sync_mode=2&doi=true&doiplus=true Authorization: Basic XXXXXXXXXXXXXXX Content-Type: application/vnd.maileon.api+xml; charset=utf-8 <contact> <!— Note that the email address is required here! --> <email>max.mustermann@xqueue.com</email> <standard_fields> <field> <name>LASTNAME</name> <value>Mustermann</value> </field> <field> <name>FIRSTNAME</name> <value>Max</value> </field> </standard_fields> <custom_fields> <field> <name>COLOR</name> <value>BLUE</value> </field> </custom_fields> </contact>
Example of contact with contact preferences
<contact> <id>12345</id> <email>max.mustermann@xqueue.com</email> <external_id>mustermann-ext-1956</external_id> <standard_fields> <field> <name>FIRSTNAME</name> <value>Max</value> </field> <field> <name>LASTNAME</name> <value>Mustermann</value> </field> </standard_fields> <custom_fields/> <preferences> <preference> <name>Shopware</name> <category>Developer</category> <value>true</value> <source nil="true"/> </preference> <preference> <name>Magento</name> <category>Developer</category> <value>false</value> <source nil="true"/> </preference> </preferences> </contact>
Inhaltsverzeichnis