CLcloudbeds
Emails

postEmailSchedule

Creates a new email schedule for existing email template. Email template can be scheduled based on two parameters: reservationStatusChange and reservationEvent. Only one of the parameters can be used. reservationStatusChange schedules email to be sent when reservation status transitions to a specific one, for instance: confirmed. reservationEvent schedules email to be sent number of days prior or after a specific event, for instance: after_check_out at a given time This call is only available for third-party integration partners, and not for property client IDs.

post/postEmailSchedule

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/postEmailSchedule
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: write:communication

Request body application/x-www-form-urlencoded

propertyIDstring nullable

Property ID

emailTemplateIDstring

ID of the email template that will be used when sending an email.

scheduleNamestring

User friendly schedule name that appears in the list. Should contain app name.

Response

200 Response

successboolean

Returns if the request could be completed

emailScheduleIDstring nullable

The ID of the created email schedule. Only present if success = true

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes

No recorded changes to this operation across all 2 revisions of this API.