Update Contact By Maileon ID
Update a contact using the maileon contact id and the corresponding checksum. This call updates standard and custom contact fields as well as the external id of the contact (if provided). It is also possible to update the permission of the contact. In case the permission is upgraded to double opt-in or double opt-in plus, a doi process can be triggered by using the corresponding parameters (and the permission is not set directly).
PUT https://api.maileon.com/1.0/contacts/contact
Attributes
| Parameter | Default | Description |
| id | The maileon contact id | |
| checksum | The checksum of the maileon contact id | |
| permission | This parameter should only be used if the permission of the contact should be updated. Supported values are 1: none, 2: single opt-in, 3: confirmed opt-in, 4: double opt-in, 5: double opt-in plus, 6: other. Please be aware of the rules specified with parameter triggerdoi | |
| triggerdoi | false | If provided and true (supported values are true and false) and if the permission is either 1, 2, 3 or 6 the permission will be set directly and NO DOI mail will be sent as it is not required for those permissions. If the permission is set to 4 (doi) or 5 (doi+), a doi process will be triggered for the contact instead of setting the permission to 4 or 5 instantly (again: the permission will not be changed). |
| src | A string intended to describe the source of the contact. If provided, the string will be stored with the doi process | |
| page_key | In case where this method was called by a landing page such as a profile update page, this string offers the possibility to keep track of it for use in reports related to doi processes | |
| doimailing | This parameter is ignored if triggerdoi is not provided or false. References the doi mailing to be used. If not provided, the default doi mailing will be used | |
| ignore_checksum | false | If this flag is set to true, the method will ignore the checksum. This flag should only be set when the call is not issued by a customer directly but by a third party application. See FAQ for further information.” |
Example
PUT https://api.maileon.com/1.0/contacts/contact?id=123&checksum=XgF91SjkC2
Authorization: Basic XXXXXXXXXXXXXXX
Content-Type: application/vnd.maileon.api+xml; charset=utf-8
<?xml version="1.0" encoding="UTF-8"?>
<contact>
<email>max.mustermann@xqueue.com</email>
<external_id>dummy</external_id>
<standard_fields>
<field>
<name>FIRSTNAME</name>
<value>Max</value>
</field>
<field>
<name>LASTNAME</name>
<value nil="true"/>
</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>Example response if contact exists
<report>
<success>false</success>
<contact>
<email>max.mustermann@xqueue.com</email>
<external_id nil="true"></external_id>
<error>
<error_field>email</error_field>
<error_message>duplicate email</error_message>
</error>
</contact>
</report>
