Send direct message

post

https://a.bluecore.com/api/namespaces/{namespace}/direct-send-messages

Sends an email using the campaign previously created using the Direct Send Campaigns API.

Emails sent through this API follow apply eligibility and per email send caps of 1 email per hour at a maximum.

Path Params

namespace

string

required

The unique name of the Bluecore environment.

Body Params

namespace

string

The namespace for this request. Must match the {namespace} path segment.

messages

array of objects

required

length ≥ 1

One or more direct messages to send.

messages*

body

string

required

length ≥ 1

HTML body of the message.

campaign_id

string

required

length ≥ 1

Bluecore campaign identifier for the third-party direct send campaign you created. Must match an existing direct send campaign in this namespace and be "live" (not a draft).

from

object

required

identifier

required

metadata

object

Arbitrary string key/value pairs stored with the send for analytics, routing, or internal tracking.

reply_to

object

subject

string

required

length ≥ 1

Email subject line shown to the recipient.

test

boolean

When true, runs as a test send, bypassing eligibility checks.

unsubscribe_replacement

string

Optional override for the unsubscribe link tag to use for unsubscribe link placement in the email body.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

429Too many requests

defaultDefault error response