Emails

postEmailTemplate

Creates a new email template. See the full list of available language parameters <a href="https://integrations.cloudbeds.com/hc/en-us/articles/360007144993-FAQ#methods-and-parameters">here</a>. This call is only available for third-party integration partners, and not for property client IDs.

post/postEmailTemplate

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/postEmailTemplate
  • 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

emailType'nonMarketing' | 'marketing'

Type of the email template: Marketing or Non-Marketing. Only applicable to GDPR-compliant properties.

namestring

Template name

fromstring

Email address from which the email message may be sent

fromNamestring nullable

from which the email message may be sent. If empty email will be used

replyTostring nullable

Email address to which the email message may be replied. If empty, the value on from parameter will be used.

replyToNamestring nullable

Name to which the email message may be replied. If empty, email will be used.

autofillAllLanguagesboolean nullable

If set, all languages will be set with the value for the property language. If not informed and only one language is sent, it's considered true, if more than one language is sent, it'll be considered false.

ccstring nullable

Email address to which the email message may be sent as a Carbon Copy

bccstring nullable

Email address to which the email message may be sent as a Blind Carbon Copy

Response

200 Response

successboolean

Returns if the request could be completed

emailTemplateIDstring nullable

The ID of the created email template. 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.