Email lists

On this page:

Get all email lists

The /api/email-lists endpoint lists all your email lists.

$ MAILCOACH_TOKEN="your API token"
$ curl ::tenantUrl::/api/email-lists \
    -H "Authorization: Bearer $MAILCOACH_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'

Searching for a specific email list by its name is possible on this endpoint using ?filter[search]=searchterm. Replace searchterm with the name of your email list, e.g. ?filter[search]=newsletter, for searching an email list called “newsletter”.

Sorting is possible on this endpoint on name, created_at, and active_subscribers_count. For example ?sort=-updated_at to sort descending on updated_at.

As a result, you get the details of all your email lists:

{
    "data": [
        {
            "uuid": "a69075c6-ff5c-4b6a-b217-12026cb72e4f",
            "name": "debitis",
            "active_subscribers_count": 0,
            "campaigns_feed_enabled": true,
            "default_from_email": "hertha.tremblay@rau.com",
            "default_from_name": "Davin Daniel",
            "allow_form_subscriptions": false,
            "redirect_after_subscribed": null,
            "redirect_after_already_subscribed": null,
            "redirect_after_subscription_pending": null,
            "redirect_after_unsubscribed": null,
            "requires_confirmation": false,
            "confirmation_mail_subject": null,
            "confirmation_mail_content": null,
            "confirmation_mailable_class": null,
            "campaign_mailer": "log",
            "automation_mailer": "log",
            "transactional_mailer": "log",
            "report_recipients": null,
            "report_campaign_sent": false,
            "report_campaign_summary": false,
            "report_email_list_summary": false,
            "email_list_summary_sent_at": null,
            "created_at": "2020-08-06T13:12:08.000000Z",
            "updated_at": "2020-08-06T13:12:08.000000Z"
        },
        ...
    ],
    "links": {
        "first": "::tenantUrl::/api/email-lists?page=1",
        "last": "::tenantUrl::/api/email-lists?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "::tenantUrl::/api/email-lists",
        "per_page": 15,
        "to": 3,
        "total": 3
    }
}

Get a specific email list

If you don’t want to retrieve all email lists, you can get a specific email list if you know its ID. The example below will get the details of the email list with ID 99.

$ MAILCOACH_TOKEN="your API token"
$ curl ::tenantUrl::/api/email-lists/a69075c6-ff5c-4b6a-b217-12026cb72e4f \
    -H "Authorization: Bearer $MAILCOACH_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'

Response:

{
    "data": {
        "uuid": "a69075c6-ff5c-4b6a-b217-12026cb72e4f",
        "name": "debitis",
        "active_subscribers_count": 0,
        "campaigns_feed_enabled": true,
        "default_from_email": "hertha.tremblay@rau.com",
        "default_from_name": "Davin Daniel",
        "allow_form_subscriptions": false,
        "redirect_after_subscribed": null,
        "redirect_after_already_subscribed": null,
        "redirect_after_subscription_pending": null,
        "redirect_after_unsubscribed": null,
        "requires_confirmation": false,
        "confirmation_mail_subject": null,
        "confirmation_mail_content": null,
        "confirmation_mailable_class": null,
        "campaign_mailer": "log",
        "automation_mailer": "log",
        "transactional_mailer": "log",
        "report_recipients": null,
        "report_campaign_sent": false,
        "report_campaign_summary": false,
        "report_email_list_summary": false,
        "email_list_summary_sent_at": null,
        "created_at": "2020-08-06T13:12:08.000000Z",
        "updated_at": "2020-08-06T13:12:08.000000Z"
    }
}

Add an email list

To add an email list, create a POST call to the /api/email-lists/ endpoint.

$ MAILCOACH_TOKEN="your API token"
$ curl -X POST ::tenantUrl::/api/email-lists \
    -H "Authorization: Bearer $MAILCOACH_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{"name":"My subscribers", "default_from_email":"john@doe.com"}'

The only required field is the email list name and default_from_email.

These are all the available fields with their validation rules:

  • name => required

  • default_from_email => required | valid email

  • default_from_name => string

  • default_reply_email => valid email

  • default_reply_name => string

  • campaign_mailer => valid mailer (defined in Laravel config)

  • automation_mailer => valid mailer (defined in Laravel config)

  • transactional_mailer => valid mailer (defined in Laravel config)

  • campaigns_feed_enabled => boolean

  • report_recipients => comma-delimited emails

  • report_campaign_sent => boolean

  • report_campaign_summary => boolean

  • report_email_list_summary => boolean

  • allow_form_subscriptions => boolean

  • requires_confirmation => boolean

  • allowed_form_subscription_tags => array

  • redirect_after_subscribed => string

  • redirect_after_already_subscribed => string

  • redirect_after_subscription_pending => string

  • redirect_after_unsubscribed => string

  • confirmation_mail => ‘send_default_confirmation_mail’ or ‘send_custom_confirmation_mail’

  • confirmation_mail_subject => required if custom_confirmation_mail = ‘send_custom_confirmation_mail’

  • confirmation_mail_content => required if custom_confirmation_mail = ‘send_custom_confirmation_mail’

If the API call succeeded, you will be given output like this:

{
    "data": {
        "id": 99,
        "uuid": "a69075c6-ff5c-4b6a-b217-12026cb72e4f",
        "name": "My subscribers",
        ...
    }
}

Update an email list

To update an email list, create a PUT call to the /api/email-lists/<uuid> endpoint. In the example below, we are updating the email list with ID 99. When updating, you should pass all fields mentioned in the payload above.

$ MAILCOACH_TOKEN="your API token"
$ curl -X PUT ::tenantUrl::/api/email-lists/a69075c6-ff5c-4b6a-b217-12026cb72e4f \
    -H "Authorization: Bearer $MAILCOACH_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{"name":"Updated name", "default_from_email":"john@doe.com"}'

Required fields and validation are the same as the create endpoint.

If the API call succeeded, you will be given output like this:

{
    "data": {
        "id": 99,
        "uuid": "a69075c6-ff5c-4b6a-b217-12026cb72e4f",
        "name": "Updated name",
        ...
    }
}

Delete an email list

To delete an email list, create a DELETE call to the /api/email-lists/<uuid> endpoint. In the example below, we are deleting the email list with ID 99.

$ MAILCOACH_TOKEN="your API token"
$ curl -X DELETE ::tenantUrl::/api/email-lists/a69075c6-ff5c-4b6a-b217-12026cb72e4f \
    -H "Authorization: Bearer $MAILCOACH_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'

If the API call succeeds, you will be given an empty response with a 204 status code.

Error handling

If an error occurs, you will be given a non-HTTP/200 response code. The resulting payload might look like this:

{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}
Tags & Segments
Authentication & Rate limiting