Mailrelay API Reference

Lists WhatsApp sent campaigns

GET /whatsapp/sent_campaigns

Lists WhatsApp sent campaigns.

Pagination

This is a paginated resource. You can optionally send two query parameters:

Parameter Description
page The page that you want to retrieve. It starts with 1.
per_page The number of records returned per page. The max allowed value for this resource is 100.

The response will include two HTTP headers:

Header Description
Total The total number of pages based on your parameters. You can use this option to know when you've reached the end of the pagination.
Per-Page The number of records returned per page.

Parameters

NameTypeDescription
page integer Page number
per_page integer Number of records per page
q[id_eq] integer Search: ID equals
q[id_gteq] integer Search: ID greater than or equal to
q[id_lteq] integer Search: ID less than or equal to
q[status_eq] string Search: Status equals
q[status_cont] string Search: Status contains
q[created_at_eq] string Search: Created at equals
q[created_at_gteq] string Search: Created at greater than or equal to
q[created_at_lteq] string Search: Created at less than or equal to
q[scheduled_at_eq] string Search: Scheduled at equals
q[scheduled_at_gteq] string Search: Scheduled at greater than or equal to
q[scheduled_at_lteq] string Search: Scheduled at less than or equal to
q[finished_at_eq] string Search: Finished at equals
q[finished_at_gteq] string Search: Finished at greater than or equal to
q[finished_at_lteq] string Search: Finished at less than or equal to
q[target_eq] string Search: Target equals
q[target_cont] string Search: Target contains
q[whatsapp_campaign_id_eq] integer Search: Whatsapp campaign equals
q[whatsapp_campaign_id_gteq] integer Search: Whatsapp campaign greater than or equal to
q[whatsapp_campaign_id_lteq] integer Search: Whatsapp campaign less than or equal to
q[s] string Allows ordering the records based on a specific field. You may optionally append "asc" or "desc" to define the direction. Example: "id desc"

Responses

StatusDescription
200 Success
401 The API key wasn't sent or is invalid
500 An internal error happened. Try again later.