CLcleverreach
mailings

return lists of mailings. 🔓

Changed on

returns lists of mailings according to following filter settings<br/> <br/> <strong>NOTE:</strong> The <code>start</code> and <code>end</code> fields depend on the <code>state</code> field.<br/>   - finished mails are filtered by finished time<br/>   - draft mails are filtered by creation time<br/>   - waiting mails are filtered by the time they will be sent<br/>   - running mails are filtered by the time they have been started<br/>

get/v3/mailings

Request

  • Base URL
    https://rest.cleverreach.com
  • URL
    https://rest.cleverreach.com/v3/mailings
  • Auth
    none declared

Query parameters

limitinteger

number of items (max 1000; max 100 when state is not 'all')

state'all' | 'finished' | 'draft' | 'waiting' | 'running' | 'automation'

state of mailing

channel_idstring

(optional): if specified, it will only return matching results

startinteger

(optional) Filter by start time (see note)

endinteger

(optional) Filter by end time (see note)

pageinteger

(optional) page number, 0-based; only effective when state is not 'all'

omit_bodyboolean

(optional) skip loading body_html and body_text - both fields remain present in the response but as empty strings; use when only listing/meta fields are needed

Response

List of mailings

string[] required

Changes