Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Communication

Send Email

Sends an email to the specified lead using the caller's outgoing email configuration.

Notes:

  • leadId, subject and content are required.
  • toEmail selects a specific email on the lead; when it is not present on the lead, the lead's primary email is used.
  • Caller must have manage permission on the lead.
post/v1.0/message/email/send

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

subjectstring required

Email subject

contentstring required

Email content

leadIdinteger required

Lead ID. When toEmail is not provided or no matching email is found for the lead, the system will use the primary email address of this lead. At least one of toEmail or leadId must be provided.

toEmailstring

Recipient email address.

Example request

{
  "subject": "Welcome to our service",
  "content": "Hello, this is a test email",
  "leadId": 563172647619608,
  "toEmail": "recipient@example.com"
}

Response

Email delivered. Response contains the message ID, subject and destination.

messageIdstring

The ID of the email message

toEmailstring

Recipient email address

subjectstring

Email subject