CUcustomer
Newsletters

List one-time sends

Changed on

Returns a list of your one-time sends (referred to as "newsletters" in our APIs) and associated metadata.

get/v1/newsletters

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/newsletters
  • Auth
    HTTP bearer

Query parameters

limitinteger

The maximum number of results you want to retrieve per page.

sort'asc' | 'desc'

Determine how you want to sort results, asc for chronological order and desc for reverse chronological order.

startstring

The token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.

Response

Returns an array of one-time send objects.

nextstring

Indicates the next page of results. Add ?start=<next_value> to the request to get the next page of results.

Example response

{
  "newsletters": [
    {
      "id": 128275,
      "deduplicate_id": "128275:1481653929",
      "type": "email",
      "content_ids": [
        45
      ],
      "name": "Weekly Product Update",
      "sent_at": 1481653929,
      "send_state": "sent",
      "scheduled_at": null,
      "created": 1481653919,
      "updated": 1481653929,
      "recipient_segment_ids": [
        42,
        99
      ],
      "tags": [
        "Product Updates"
      ],
      "subscription_topic_id": 5
    }
  ]
}

Changes

  • f3a28f896929Revision changes
    • breaking

      the response property // became nullable for the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 7aca33a41082Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status