API DocumentationMailing: GetList
Method to get the list of mailings.
Resource URL
https://api.wbsrvc.com/Mailing/GetList/
Method
POST
Parameters
| user_key Required |
User Key of the user who initiates the call. Type: string |
| status Optional |
Filter using the mailing status. Type: string - possible value 'incomplete', 'scheduled', 'delivering', 'delivered' |
| type Optional |
Filter using the mailing type. Type: string - possible value 'standard', 'recurring', 'absplit' |
| name Optional |
Filter using the mailing name. Type: string |
| list_id Optional |
Filter using the ID of the mailing list. Type: integer |
| campaign_id Optional |
Filter using the ID of the mailing campaign. Type: integer |
| recurring_id Optional |
Filter using the ID of the mailing recurrence. Type: integer |
| start_date Optional |
Filter using a start date. Type: date - yyyy-mm-dd hh:mm:ss |
| end_date Optional |
Filter using a end date. Type: date - yyyy-mm-dd hh:mm:ss |
| sort_by Optional |
Sort resulting mailings. Type: string - possible value 'name', 'created_on', 'scheduled_for', 'scheduled_on', 'active_emails' |
| direction Optional |
Direction of the sorting. Type: string - possible value 'asc', 'desc' |
| limit Optional |
Limit the number of resulting mailings. Type: integer |
| offset Optional |
Offset the beginning of resulting mailings. Type: integer |
| count Optional |
Return the number of mailings. Type: string - possible value 'true', 'false' |
| client_id Optional |
Client ID of the client in which the mailing is located. Type: integer |