Send

POST /v1/campaigns/{id}/send

Queues the mailpieces of the campaign for sending. There is a time window where the mailpieces can be cancelled which is 15 minutes by default. The cancellation window can be modified using the date parameter.

Path Parameters

id

integer

Required

The id of the campaign.

Query Parameters

date

date

Optional

Defaults to 15 mintues in the future

An ISO 8601 formatted timestamp of the date the campaign should be sent on. It must be in at least 15 minutes in the future and the maximum of 90 days.

Example Request

curl -X POST https://api.realmailers.com/v1/campaigns/{id}/send \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response Schema

{
  scheduled_at: Timestamp(ISO8601)
  created_at: Timestamp(ISO8601)
  updated_at: Timestamp(ISO8601)
  sent_at: Timestamp(ISO8601)

  expected_delivery_date: String
  send_copy_to_sender: Boolean
  recipient_count: Number
  property_filter: JSON
  postage_class: String
  template_id: Number
  status: String
  price: String
  proof: URL
  size: Size
  id: Number

  thumbnails: Array(URL)
  designs: Array(URL)

  exposed_addresses: Array({
    address_country: String
    address_line1: String
    address_state: String
    address_city: String
    address_zip: String
    variables: JSON
    company: String
    name:String
  })

  sender: {
    address_country: String
    address_line1: String
    address_state: String
    address_city: String
    address_zip: String
    variables: JSON
    company: String
    name:String
  }

  meta_data: {
    key: String
  }
}