+49 69 83008980 service@xqueue.com

Benötigen Sie Hilfe?

Get Mailings By States

Sie sind hier:
< Alle Themen
 

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

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

Attributes

Parameter Default Description
states This is a list of states that the mailings shall match. Valid are: draftfailedqueuedchecksblacklistpreparingsendingcanceledpauseddonearchivingarchivedreleased, and scheduled (=waiting to be sent),
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: statetypename, 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/states?page_index=1&page_size=2&states=draft
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&states=draft>; rel="next"
Link: <https://api.maileon.com/1.0/mailings/filter/types?page_index=1&page_size=2&states=draft>; rel="start"
X-Items: 3
X-Pages: 2

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

Example 2

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

<?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