CampaignRecipientExecutionPlanInput Input Object
Sender identity fields are deliberately absent: they are server-managed (set by the drafting pipeline, preserved across plan edits) so a client can never reassign whose mailbox an email sends from.
Fields
#
additionalAttendeeUserId
agendaItem
attachmentFileIds
Hive file IDs to attach to this email. Upload arbitrary files with prepareFileLibraryUploads, PUT the bytes, then completeFileLibraryUploads first. Files must be readable in this workspace by the editor and sender. Attaching a File Library file that is not yet visible to everyone shares it with everyone in the workspace, so any teammate can send the email; the save is refused when the caller cannot change that file's sharing. Omit to preserve selection; null or [] clears it. Mail-provider size limits apply. Explicit consent before saving must name that sharing change; include selected files in explicit consent before sending.
bccEmails
Addresses to blind-copy on this email. Omit to keep the current list; null or [] clears it. Include them in explicit consent before sending.
bodyHtml
canvas
ccEmails
Addresses to copy on this email. Omit to keep the current list; null or [] clears it. Include them in explicit consent before sending.
ctaLabel
ctaUrl
followUpDrafts
Email plans only: this person's drafts of the campaign's follow-up steps that have emailRules, each sent as written once the first email launched. Omit to keep them; [] clears them. Each must keep its step's emailRules.
meetingTitle
scheduledSendAt
Send the email at this time once launched, at most 90 days ahead; a past time sends at once. Omit to keep the current time; null clears it.
subject
toEmail