Template

Send an email template to a single person as a one-off email.

The email is merge-rendered for the person and sent immediately. No broadcast is created. People who have bounced, unsubscribed or reported spam are not sent the email. Only templates from Email > Email templates can be sent.

The response holds the record of the send. Read the open and click analytics for it later from the emails endpoint for the template. The template and the recipient are left out of the response unless they are asked for, for example fields=*,Template.Uid,Recipient.Uid.

post/api/v1/templates/{templateUid}/send

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/templates/{templateUid}/send
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

templateUidstring nullable required

The Uid of the email template to send.

Request body

PersonUidstring nullable

The Uid of the person to send the email to. Required.

FromEmailstring nullable

The from address. Defaults to the support email address for the account.

FromNamestring nullable

The from name. Defaults to the company name.

Subjectstring nullable

Overrides the subject of the template.

Response

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
UniqueMessageIdstring nullable
Subjectstring nullable
FromEmailstring nullable
FromNamestring nullable
SendDateTimestring date-time
ProcessDateTimestring date-time nullable
DeliverDateTimestring date-time nullable
BounceDateTimestring date-time nullable
SpamDateTimestring date-time nullable
OpenDateTimestring date-time nullable
ClickDateTimestring date-time nullable
UnsubscribeDateTimestring date-time nullable
SendErrorstring nullable

Example response

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "Template": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "Name": "string",
    "Subject": "string",
    "Body": "string",
    "Design": "string",
    "Description": "string",
    "SystemName": "string",
    "IsInternal": false,
    "AvailableTokens": "string",
    "RequiredTokens": "string",
    "Tag": "string"
  },
  "Recipient": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "SchemaLessData": {},
    "Email": "string",
    "FirstName": "string",
    "LastName": "string",
    "MailingAddress": {},
    "PasswordLastUpdated": "string",
    "PasswordMustChange": false,
    "PhoneMobile": "string",
    "PhoneWork": "string",
    "ProfileImageS3Url": "string",
    "Title": "string",
    "Timezone": "string",
    "Language": "string",
    "IPAddress": "string",
    "Referer": "string",
    "UserAgent": "string",
    "LastLoginDateTime": "string",
    "OAuthGoogleProfileId": "string",
    "PersonAccount": [],
    "DealPeople": [],
    "LeadFormSubmissions": [],
    "Account": {},
    "AccountUids": "string",
    "EmailListPerson": [],
    "FullName": "string",
    "HasLoggedIn": false,
    "OAuthIntegrationStatus": 0,
    "OptInToEmailList": false,
    "Password": "string",
    "RecaptchaToken": "string",
    "UserAgentPlatformBrowser": "string",
    "HasUnsubscribed": false,
    "DiscordUser": {},
    "IsConnectedToDiscord": false
  },
  "UniqueMessageId": "string",
  "Subject": "string",
  "FromEmail": "string",
  "FromName": "string",
  "SendDateTime": "string",
  "ProcessDateTime": "string",
  "DeliverDateTime": "string",
  "BounceDateTime": "string",
  "SpamDateTime": "string",
  "OpenDateTime": "string",
  "ClickDateTime": "string",
  "UnsubscribeDateTime": "string",
  "SendError": "string"
}

Changes