Skip to main content
POST
Queue outbound email(s) from your Agent

Authorizations

token
string
query
required

Vida API Token

Body

application/json
content
string
required

Email body. Raw HTML is supported.

target
string

Destination email address

Example:

"person@example.com"

to
any

Destination email address or array of destination email addresses for one email

cc
any

CC email address or array of CC email addresses for one email

bcc
any

BCC email address or array of BCC email addresses for one email

subject
string

Email subject line

attachments
array

SendGrid-style attachment objects with base64 content

context
string

Optional context for the task

taskContext
string

Task-specific context

accountId
integer

Optional agent account id override

agentId
integer

Optional campaign id override

roomId
string

Room id when replying to an existing email message

replyToMessageUuid
string

Email message uuid to reply to; used with roomId for thread headers

scheduledFor
integer

Unix seconds to schedule delivery

meta
object

Optional metadata

externalTaskId
string

Optional customer-provided identifier applied to created task(s)

Response

Queued successfully