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

Get Contacts By Filter Id

Sie sind hier:
< Alle Themen
Get all contacts that match the filter with the ID

GET https://api.maileon.com/1.0/contacts/filter/{contactFilterId}

 

Attributes

ParameterDefaultDescription
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.
page_index1The index of the result page. The index must be greater or equal to 1.
page_size100The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.

The response contains a permission type, this is one of the following strings:

ValueType ID
none1
soi2
coi3
doi4
doi+5
other6

 

GET https://api.maileon.com/1.0/contacts/filter/{contactFilterId}
Content-type: application/vnd.maileon.api+xml
Accept: application/vnd.maileon.api+xml; charset=utf-8
Authorization: [XXX]

Status: 200 OK
Content-Type: application/vnd.maileon.api+xml;charset=utf-8
Link: <https://api.maileon.com/1.0/contacts/filter/1?page_index=1&standard_field=FIRSTNAME&page_size=5>; rel="start"
X-Items: 3
X-Pages: 1

<?xml version="1.0" encoding="UTF-8"?>

<contacts>
  <contact anonymous="true">
    <id>112</id>
    <external_id>someExternalId2</external_id>
  </contact>
  <contact anonymous="true">
    <id>113</id>
    <external_id>someExternalId2</external_id>
  </contact>
  <contact>
    <id>114</id>
    <email>xq@xqueue.com</email>
    <permissionStatus>available</permissionStatus>
    <permissionType>doi+</permissionType>
    <external_id nil="true"/>
    <standard_fields>
      <field>
        <name>FIRSTNAME</name>
        <value nil="true"/>
      </field>
    </standard_fields>
    <custom_fields/>
  </contact>
</contacts>

Example of contact with contact preferences

<contacts>
  <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>
</contacts>
Inhaltsverzeichnis

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

Maileon ist ein Produkt der XQueue GmbH