Use Cases
Log In

Cancel campaign

POST /v2/campaigns/{id}/cancel

Cancels a scheduled campaign and returns its details.

Path Parameters

id
string
Required
Campaign ID.
curl -X POST https://www.realmailers.com/v2/campaigns/1/cancel \
  -H 'Authorization: Bearer YOUR_API_KEY USER_EMAIL'
{
  expected_delivery_date: Timestamp(ISO8601)
  scheduled_at: Timestamp(ISO8601)
  created_at: Timestamp(ISO8601)
  updated_at: Timestamp(ISO8601)
  sent_at: Timestamp(ISO8601)

  send_copy_to_sender: Boolean
  notification_email: String
  targeting_method: String
  recipient_count: Number
  discount_code: String
  postage_class: String
  template_id: Number
  status: String
  price: Number
  name: String
  id: Number

  thumbnails: Array(URL)
  artworks: Array(URL)
  proof: URL

  targeting_center: {
    coordinates: Array(Number)
    postcard_count: Number
    address: String
  }

  template_data: {
    landing_page_url: String
    square_footage: Number
    lot_size_type: String
    description: String
    maintenance: Number
    back_title: String
    photos: Array(URL)
    bathrooms: Number
    bedrooms: Number
    lot_size: Number
    address: String
    label: String
    price: Number
    taxes: Number

    variables: {
      key: String
    }
  }

  company: {
    street_address: String
    state: String
    name: String
    city: String
    zip: String
    logo: URL
  }

  agent: {
    license_number: String
    cell_phone: String
    first_name: String
    last_name: String
    landline: String
    email: String
    photo: URL
  }

  meta_data: {
    key: String
  }
}