NameDescriptionTypeAdditional information
ContactId

Id of the contact the email is being sent for.

integer

None.

PolicyId

Id of the policy to associate with this email. When provided, the email is scoped to the policy. Omit or pass null for contact-level emails.

integer

None.

EmailUserAccountId

Id of the EmailUserAccount to send from. Sender selection depends on this field together with UseSystemEmailFrom. (1) Provided (greater than 0) and UseSystemEmailFrom = false: the email is sent from this specific account, which is validated (must exist and be valid), and the user's default account is not used. (2) Omitted or 0, and UseSystemEmailFrom = false: the email is sent from the current user's default email account, and an error is returned if the user has no default account or it is not valid. (3) UseSystemEmailFrom = true: this field is ignored and the email is sent from the QQCatalyst system address.

integer

None.

ToEmails

Comma-separated list of recipient email addresses.

string

None.

CcEmails

Comma-separated list of CC email addresses.

string

None.

BccEmails

Comma-separated list of BCC email addresses.

string

None.

Subject

Subject line of the email.

string

None.

Body

HTML body of the email. Literal @@ sequences are converted to @ before sending.

string

None.

ExcludeEmailSignature

Controls whether the sending employee's saved email signature is appended to the body. When false (default) the employee's email signature is appended after the body. When true the signature is not appended (use when the caller already includes its own signature in the Body). Has no effect when the employee has no configured signature.

boolean

None.

Description

Internal description stored with the resulting document record.

string

None.

EmailSource

Source tag stored with the resulting document record. Defaults to "API" when not supplied.

string

None.

UseSendGridApi

When true, the email is sent via SendGrid instead of SMTP. When false (default), the email is sent via SMTP.

boolean

None.

UseSystemEmailFrom

Controls whether the email is sent from the QQCatalyst system address. This field takes priority over EmailUserAccountId. When true, the email is sent from the QQCatalyst system address and EmailUserAccountId is ignored (whether or not it is supplied). When false (default) with EmailUserAccountId greater than 0, the email is sent from that specific user account. When false (default) with EmailUserAccountId omitted or 0, the email is sent from the current user's default email account (an error is returned if there is no valid default).

boolean

None.

Attachments

File and image attachments to include. Each entry pairs a file ID with its display name. Example: [{"FileId": 1, "FileName": "policy.pdf"}, {"FileId": 2, "FileName": "form.pdf"}]

Collection of EmailFileAttachmentDTO

None.

AttachAcordList

ACORD form attachments to include.

Collection of EmailAcordAttachDTO

None.