cms

Send a CMS email

Send a CMS email

post/cms/v1/emails/send

Request

  • Base URL: https://api.beamcheckout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.beamcheckout.com/cms/v1/emails/send
  • Auth: none declared. Required headers: X-Beam-Timestamp, X-Beam-Signature, X-Beam-Idempotency-Key

Headers

X-Beam-Timestampstring required

RFC3339 timestamp at which the request is sent

X-Beam-Signaturestring required

base64-encoded HMAC-SHA256 of the concatenation of X-Beam-Timestamp and raw request body {timestamp}{body}

X-Beam-Idempotency-Keystring required

idempotency key

Request body

cmsEntryIdstring required
htmlBodystring required
recipientstring required
sheetsIdstring required
subjectstring required

Response

success

codeinteger

Code is the http status code

messagestring

Message is the message to return in response body

Changes

No recorded changes to this operation across all 1 revision of this API.