Get Blocked Contacts

API version 1.0.0

Returns a page of blocked contacts. Blocked contacts are contacts with available permission but that are blocked for sendouts because of blacklist matches or similar reasons such as bounce policy.

Attributes

Parameter Default Description
standard_field Multivalued parameter to query the value of a standard contact field.
custom_field Multivalued parameter to query the value of a custom contact field.
page_index The index of the result page. The index must be greater or equal to 1.
page_size 100 The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.

Example

GET https://api.maileon.com/1.0/contacts/blocked?page_size=5&page_index=3&standard_field=FIRSTNAME&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
Link: <http://api.maileon.com/1.0/contacts/blocked?page_index=1&page_size=5&standard_field=FIRSTNAME&custom_field=COLOR>; rel="start"
Link: <http://api.maileon.com/1.0/contacts/blocked?page_index=2&page_size=5&standard_field=FIRSTNAME&custom_field=COLOR>; rel="prev"
Link: <http://api.maileon.com/1.0/contacts/blocked?page_index=4&page_size=5&standard_field=FIRSTNAME&custom_field=COLOR>; rel="next"
X-Pages: 4
X-Items: 22

<?xml version="1.0" encoding="UTF-8"?>
<contacts>
<contact>
  <id>123</id>
  <email>max.mustermann@xqueue.com</email>
  <external_id>dummy</external_id>
  <blocking_reason>blacklist</blocking_reason>
  <blocking_timestamp>2013-05-15 20:59</blocking_timestamp>
  <standard_fields>
    <field>
      <name>FIRSTNAME</name>
      <value>Max</value>
    </field>
  </standard_fields>
  <custom_fields>
      <field>
        <name>COLOR</name>
        <value>BLUE</value>
      </field>
   </custom_fields>
</contact>
<contact>…</contact>
</contacts>