API Reference

Send email message

post
https://elastic.messangi.me/crowsnest/v2/emails

Requires authentication — see Authentication.

Sends a single email. Query parameters are supported.

This endpoint is used in the Email guide.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Related pages

How to

Query Params
string

Defines the display text for the unsubscribe link included in the email body, allowing recipients to opt out from future communications. This text will appear as the clickable anchor in the unsubscribe URL.

Body Params
string
required

Recipient’s email address.

string
required

Sender's verified email address.

string
required

Email content (can be plain text or HTML).

string
required

Subject line of the email.

string
required

Alphanumeric identifier used for reporting purposes.

string

Unique user identifier that can be used for reporting purposes. This is an identifier you can use to uniquely identify the destination address in your systems. This is similar to the externalId and will be sent back to you if you are requesting callbacks that contain status changes of the messages you send.

callbacks
array of strings

Indicate one or more (separated by comma) webhook URLs to notify about the status of the message delivery.That is, If you want to receive the status of the message you've sent to your contacts, you need to specify your endpoint.

Your endpoint must have a HTTP POST access method and receive a JSON body.

The URL is the external callback where the events of the Email will be registered and published. Once an email is processed, its status will be posted to your callback URL.

To view the full list and meaning of each status, please refer to the Email Status section.

callbacks
string

Assign a custom label or reference name to the email recipient.

Responses

Updated 14 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 14 days ago