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

Im Maileon Help-Center finden Sie umfassende Dokumentationen zu unserem System.

Beliebte Suchanfragen: Importe | Rest-API | Integrationen | SMS

Get Mailings By Types

Sie sind hier:

Returns a page of mailings in the account that match the given types (one or a list)

GET https://api.maileon.com/1.0/mailings/filter/types

Attributes

Parameter Default Description
types This is a list of types that the mailings shall match. Valid are: doi, regular, and trigger
fields This list contains the fields that shall be returned with the result. If this list is empty, only the IDs will be returned. Valid fields are: state, type, name, and scheduleTime
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.
page_index 1 The index of the result page. The index must be greater or equal to 1.
orderBy id This field can be used to change the order field. Allowed values are: is, state, name, and schedule_time.
order ASC This field sets the order direction, by default this is set to an ascending order.

Example 1

GET https://api.maileon.com/1.0/mailings/filter/types?page_index=1&page_size=2&types=doi
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
Link: <https://api.maileon.com/1.0/mailings/filter/types?page_index=1&page_size=2&types=doi>; rel="start"
X-Items: 2
X-Pages: 1

<?xml version="1.0" encoding="UTF-8"?>
<mailings>
  <mailing>
    <id>4</id>
    <fields/>
  </mailing>
  <mailing>
    <id>6</id>
    <fields/>
  </mailing>
</mailings>

Example 2

GET https://api.maileon.com/1.0/mailings/filter/types?page_index=1&page_size=2&fields=state&fields=type&fields=name&fields=scheduleTime&types=doi&types=regular
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
Link: <https://api.maileon.com/1.0/mailings/filter/types?page_index=2&page_size=2&fields=state&fields=type&fields=name&fields=scheduleTime&types=doi&types=regular>; rel="next"
Link: <https://api.maileon.com/1.0/mailings/filter/types?page_index=1&page_size=2&fields=state&fields=type&fields=name&fields=scheduleTime&types=doi&types=regular>; rel="start"
X-Items: 9
X-Pages: 4

<?xml version="1.0" encoding="UTF-8"?>
<mailings>
  <mailing>
    <id>1</id>
    <fields>
      <field>
        <name>name</name>
        <value>Mailing1</value>
      </field>
      <field>
        <name>state</name>
        <value>draft</value>
      </field>
      <field>
        <name>type</name>
        <value>regular</value>
      </field>
      <field>
        <name>scheduleTime</name>
        <value>2014-10-06 12:00:00</value>
      </field>
    </fields>
  </mailing>
  <mailing>
    <id>2</id>
    <fields>
      <field>
        <name>name</name>
        <value>Newsletter August</value>
      </field>
      <field>
        <name>state</name>
        <value>draft</value>
      </field>
      <field>
        <name>type</name>
        <value>regular</value>
      </field>
      <field>
        <name>scheduleTime</name>
        <value nil="true"/>
      </field>
    </fields>
  </mailing>
</mailings>
Inhaltsverzeichnis