Skip to main content
POST
/
actions
/
send_email
Send an email
curl --request POST \
  --url https://api.hyperspell.com/actions/send_email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": [
    "<string>"
  ],
  "subject": "<string>",
  "body": "<string>",
  "provider": "gmail_actions",
  "connection": "<string>",
  "cc": [
    "<string>"
  ],
  "bcc": [
    "<string>"
  ]
}
'
import requests

url = "https://api.hyperspell.com/actions/send_email"

payload = {
"to": ["<string>"],
"subject": "<string>",
"body": "<string>",
"provider": "gmail_actions",
"connection": "<string>",
"cc": ["<string>"],
"bcc": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: ['<string>'],
subject: '<string>',
body: JSON.stringify('<string>'),
provider: 'gmail_actions',
connection: '<string>',
cc: ['<string>'],
bcc: ['<string>']
})
};

fetch('https://api.hyperspell.com/actions/send_email', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperspell.com/actions/send_email",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'to' => [
'<string>'
],
'subject' => '<string>',
'body' => '<string>',
'provider' => 'gmail_actions',
'connection' => '<string>',
'cc' => [
'<string>'
],
'bcc' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.hyperspell.com/actions/send_email"

payload := strings.NewReader("{\n \"to\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"provider\": \"gmail_actions\",\n \"connection\": \"<string>\",\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.hyperspell.com/actions/send_email")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"provider\": \"gmail_actions\",\n \"connection\": \"<string>\",\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.hyperspell.com/actions/send_email")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": [\n \"<string>\"\n ],\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"provider\": \"gmail_actions\",\n \"connection\": \"<string>\",\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "error": "<string>",
  "provider_response": {}
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Body

application/json

Send an email via Gmail.

to
string[]
required

Recipient email addresses

subject
string
required

Email subject line

body
string
required

Email body (plain text)

provider
enum<string>
default:gmail_actions

Integration provider

Available options:
reddit,
notion,
slack,
google_calendar,
google_mail,
box,
dropbox,
github,
google_drive,
vault,
web_crawler,
trace,
microsoft_teams,
gmail_actions,
granola,
fathom,
fireflies,
linear,
hubspot,
salesforce,
coda,
lightfield,
gong,
pylon,
clickup
connection
string | null

Connection ID. If omitted, auto-resolved from provider + user.

cc
string[] | null

CC recipients

bcc
string[] | null

BCC recipients

Response

Successful Response

Result from executing an integration action.

success
boolean
required
error
string | null
provider_response
Provider Response · object | null