Create (and optionally send) an email message

Create a new email message record. Optionally send the email by setting send: true.

Default behavior (send: false or omitted):

  • Creates a record in the CRM without sending
  • Use this to log emails sent through external systems

Sending emails (send: true):

  • Uses team's default provider if emailProviderId is not specified
  • Optionally specify emailProviderId to use a specific provider
  • Actually sends the email through the specified/default provider
  • Provider must be configured and accessible to the API token

Auto-fill behavior:

  • If toEmail is blank/omitted, uses the person's primary email (or returns error if none exists)
  • If fromEmail is blank/omitted, uses the default email provider's sender email (or returns error if no provider configured)
  • This allows simplified message creation when using default contact information
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Set to true to actually send the email (default: false)

uuid

Email provider ID to use for sending (optional if send=true).
If not specified when send=true, uses team's default email provider.

Body Params
uuid
required

ID of the person this email is for

uuid

User who sent the email (defaults to current user)

string
required
string
required
string

Recipient email address. If blank, uses person's primary email. Returns error if person has no primary email.

string

Sender email address. If blank, uses default email provider's sender email. Returns error if no default provider configured.

Responses
201

fromEmail validation - user token with correct email

401

unauthorized

404

person not found

422

fromEmail validation - user token with wrong email

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!