BCDR Cloud API icon

BCDR Cloud API

BCDR Company Cloud API integration for business communications

Actions90

Message → Send Marketing Message

AI-generated

Summary

Send a marketing message using a specified marketing template, optionally including message activity sharing and callback data, to a recipient optionally verified by their identity key hash.

Inputs

  • Marketing Template (required) — A JSON object defining the marketing template details including its name, language code, and components to be used in the marketing message.
  • Message Activity Sharing — A boolean flag to indicate whether to share message activity status.
  • Callback Data — A string up to 512 characters to include custom callback data associated with the message.
  • Recipient Identity Key Hash — An optional string representing the recipient's identity key hash for verification purposes.

Output shape

a JSON response object indicating the success or failure of the marketing message send operation, including any relevant message metadata returned by the API.

The response structure depends on the API response from the BCDR Cloud. Error handling and specific fields returned may vary. This operation sends the message immediately rather than queuing or batching.

Links

Discussion