- cURL
- JSON
curl -X POST https://api.tapeapp.com/v1/email/send \
-H "Authorization: Bearer $TAPE_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"to": "riley@acme.com",
"subject": "Your viewing on Friday",
"html": "<p>Your viewing of 12 Harbor Street is confirmed for Friday at 10 am.</p>",
"reply_to": "juliet@acme.com"
}'
{
"to": "riley@acme.com",
"subject": "Your viewing on Friday",
"html": "<p>Your viewing of 12 Harbor Street is confirmed for Friday at 10 am.</p>",
"reply_to": "juliet@acme.com"
}
{
"status": "SUCCESSFULLY_SCHEDULED"
}
Use this endpoint to send emails from Tape to people outside Tape.
Send an email
Use this endpoint to send an email to one or more recipients.
/v1/email/sendapi.tapeapp.com- cURL
- JSON
curl -X POST https://api.tapeapp.com/v1/email/send \
-H "Authorization: Bearer $TAPE_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"to": "riley@acme.com",
"subject": "Your viewing on Friday",
"html": "<p>Your viewing of 12 Harbor Street is confirmed for Friday at 10 am.</p>",
"reply_to": "juliet@acme.com"
}'
{
"to": "riley@acme.com",
"subject": "Your viewing on Friday",
"html": "<p>Your viewing of 12 Harbor Street is confirmed for Friday at 10 am.</p>",
"reply_to": "juliet@acme.com"
}
{
"status": "SUCCESSFULLY_SCHEDULED"
}
Send the recipients in to, the subject in subject and the formatted body in html.
The example sends an email to riley@acme.com. When Riley replies, the reply goes to juliet@acme.com.
Tape hands the email to the mail server during the request. SUCCESSFULLY_SCHEDULED means the mail server accepted it, not that it reached the recipient. The API can't check delivery.
General behavior
- Content access doesn't limit this endpoint. A token limited to one workspace can still send email.
- If the mail server rejects a recipient, Tape tries that recipient again a few times within the same request.
- Tape limits how many emails an organization sends per day through Tape's own servers. To send more, use your own SMTP server. See Sender address.
Requirements: email:send. Works with a personal access token, an OAuth access token, a user API key or an automation API key.
Errors
- A request without a valid recipient in
to,ccorbccreturns400withemail_send_failure. The message reads[EmailSendFailureException] Sending Email failed with reason: Error: No recipients defined. - A mail server that can't be reached, or still rejects the email at the last attempt, returns
400withemail_send_failure. - An email over your organization's daily limit for Tape's own servers returns
400withemail_send_failure. - Attachments over the maximum total size return
400withvalidation. See Limits. - A file in
attachment_idsyou don't have access to returns403.
Optional body parameters
cc,bccandreply_to: one email address or a list of them.from_name: the sender name your recipients see.attachment_ids: a list of file IDs to attach. See Attachments.from_addressandsmtp_settings_id: send from your own address. See Sender address.
Attachments
attachment_ids accepts these file IDs:
- files in attachment or image fields of records. See Attachment field value.
- files you uploaded with the File resource.
- files attached to record comments or replies.
You need access to every file you attach.
Sender address
Without your own email server, Tape sends from noreply@automations.tapeapp.com. If you set reply_to, Tape sends from reply@automations.tapeapp.com. Set from_name to show your own sender name.
To send from your own address, add an SMTP account in the Send an email action of an automation:
- Open an automation and add the action Send an email.
- Select Show more, open the Account menu and select Add account.
- On the SMTP tab, enter the user name, password, server address and port, then select Save account.
- To make the account the default of your organization, open the Account menu, select the three dots next to the account and select Set as default.
Tape then sends through your organization's default SMTP account. To pick another one, set smtp_settings_id.
The API has no endpoint that lists SMTP accounts, and the Account menu doesn't show the ID. To find it in the automation editor:
- In a Send an email action, select the account in the Account menu.
- In the action menu, select Duplicate.
- In the action menu of the copy, select Turn into → Execute script. The script shows the ID in
smtp_settings_id. - Remove the copy.
The automation API returns the same ID as smtp_account_id of the action.
Set the sender address in from_address. Without it, Tape uses the user name of the SMTP server.
Your SMTP server must be allowed to send emails for this address. Otherwise, delivery fails.
The example sends an email from juliet@acme.com to two recipients, with two people in copy. It attaches the file with ID 42, a file in an attachment field of a record.
- cURL
- JSON
curl -X POST https://api.tapeapp.com/v1/email/send \
-H "Authorization: Bearer $TAPE_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"from_address": "juliet@acme.com",
"from_name": "Juliet from Acme",
"to": ["riley@acme.com", "sam@acme.com"],
"subject": "Offer for 12 Harbor Street",
"html": "<p>The signed offer is attached.</p>",
"cc": ["will@acme.com", "nora@acme.com"],
"attachment_ids": [42]
}'
{
"from_address": "juliet@acme.com",
"from_name": "Juliet from Acme",
"to": ["riley@acme.com", "sam@acme.com"],
"subject": "Offer for 12 Harbor Street",
"html": "<p>The signed offer is attached.</p>",
"cc": ["will@acme.com", "nora@acme.com"],
"attachment_ids": [42]
}
{
"status": "SUCCESSFULLY_SCHEDULED"
}
Limits
Tape enforces these limits for each email:
Maximum total attachment size
20 MB
| Variable | Limit |
|---|---|
| Maximum total attachment size | 20 MB |
Rate limit credits
Sending an email costs the base request cost of 10 credits, whatever the number of recipients in to, cc and bcc.
One email to several recipients uses fewer credits than separate emails to each of them. Recipients in to and cc see each other. Put recipients in bcc if they shouldn't, and check that your choice fits your privacy policy.