+49 69 83008980 service@xqueue.com
Benötigen Sie Hilfe?

Get Contact By Maileon ID

Sie sind hier:
< Alle Themen

Return a contact using the maileon contact id. This resource is intended to be used in profile update pages to prefill profile update forms. In order to prevent form fields manipulation, a checksum of the maileon contact id is required as parameter. Please refer to the documentation of the profile update pages for more details about how to get the maileon contact id and the corresponding checksum.

GET https://api.maileon.com/1.0/contacts/contact

 

Attributes

ParameterDefaultDescription

idThe maileon contact id.
checksumThe checksum of the maileon contact id.
standard_fieldMultivalued parameter to query the value of a standard contact field. If a standard field has no value, it will be returned with nil-type value: <value nil=“true”></value>.
custom_fieldMultivalued parameter to query the value of a custom contact field. If no custom fields are specified, tag <custom_fields/> is returned, if a custom field has no value it will be removed from the answer.
preference_categoriesMultivalued parameter to query the preference values of a contact preference category. If nothing is specified the returned tag <preferences> will be ommitted.
ignore_checksumfalseIf 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

GET https://api.maileon.com/1.0/contacts/contact?id=123&checksum=XgF91SjkC2&standard_field=FIRSTNAME&standard_field=LASTNAME&custom_field=COLOR
Authorization: Basic XXXXXXXXXXXXXXX
Accept: application/vnd.maileon.api+xml; charset=utf-8

Status: 200 OK
Content-Type: application/vnd.maileon.api+xml

<?xml version="1.0" encoding="UTF-8"?>
<contact>
  <id>123</id>
  <!-- 1:none, 2:single opt-in, 3: confirmed opt-in, 4:double opt-in,
      5: double opt-in plus, 6: other-->
  <permission>1</permission>
  <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"/>
      <last_modified>2021-08-19T15:30:53+0200</last_modified>
    </preference>
    <preference>
      <name>Magento</name>
      <category>Developer</category>
      <value>false</value>
      <source nil="true"/>
      <last_modified>2021-08-19T15:30:53+0200</last_modified>
    </preference>
  </preferences>
</contact>
Inhaltsverzeichnis

Bleiben Sie Up-to-Date und profitieren Sie von spannenden News und Aktionen.

Maileon ist ein Produkt der XQueue GmbH