Transactional Email
POST
/api/v1/workspaces/{workspaceId}/messaging/transactional-emails/{emailId}/send
Scope messaging:write
Send a published transactional email template to one recipient, with the variables the template expects.
Pfad
emailIdPflicht
string (uuid)
Transactional email template identifier.
workspaceIdPflicht
string
Workspace that owns the resource.
Request
application/json · SendTransactionalEmailRequestDto
toEmail
string
Email address of the to.
recordId
string (uuid)
Identifier of the record.
variables
object
createContact
boolean
Whether create contact is set.
firstName
string
Name of the first.
lastName
string
Name of the last.
Antworten
200TransactionalEmailSendAcceptedDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.
Transactional email send accepted.
batchId
string (uuid)
Identifier of the batch.
candidateCount
integer (int32)
Number of candidate.
eligibleCount
integer (int32)
Number of eligible.
excludedCount
integer (int32)
Number of excluded.
queuedCount
integer (int32)
Number of queued.
contactRecordId
string (uuid)
Identifier of the contact record.