Send and log an email

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/accounts/ACC0001/communications/emails" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": [
      "jane@example.com"
    ],
    "subject": "Your account",
    "body": "Hello Jane, your account is ready."
  }'

from exsited import build_client

client = build_client()

response = client.accounts.send_account_email(
    "ACC0001",
    {
        "to": ["jane@example.com"],
        "subject": "Your account",
        "body": "Hello Jane, your account is ready.",
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.accounts.sendAccountEmail('ACC0001', {
    to: ['jane@example.com'],
    subject: 'Your account',
    body: 'Hello Jane, your account is ready.',
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->accounts->sendAccountEmail('ACC0001', [
    'to' => ['jane@example.com'],
    'subject' => 'Your account',
    'body' => 'Hello Jane, your account is ready.',
]);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.List;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.accounts().sendAccountEmail(
        "ACC0001",
        Map.of(
                "to", List.of("jane@example.com"),
                "subject", "Your account",
                "body", "Hello Jane, your account is ready."));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Accounts.SendAccountEmailAsync(
    "ACC0001",
    new Dictionary<string, object?>
    {
        ["to"] = new List<object?>
        {
            "jane@example.com",
        },
        ["subject"] = "Your account",
        ["body"] = "Hello Jane, your account is ready.",
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.accounts.sendAccountEmail('ACC0001', {
  'to': ['jane@example.com'],
  'subject': 'Your account',
  'body': 'Hello Jane, your account is ready.',
});
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Accounts().SendAccountEmail(context.Background(), "ACC0001", map[string]any{
	"to":      []any{"jane@example.com"},
	"subject": "Your account",
	"body":    "Hello Jane, your account is ready.",
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

POST

accounts

{account_id}

communications

emails

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/accounts/ACC0001/communications/emails" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": [
      "jane@example.com"
    ],
    "subject": "Your account",
    "body": "Hello Jane, your account is ready."
  }'

from exsited import build_client

client = build_client()

response = client.accounts.send_account_email(
    "ACC0001",
    {
        "to": ["jane@example.com"],
        "subject": "Your account",
        "body": "Hello Jane, your account is ready.",
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.accounts.sendAccountEmail('ACC0001', {
    to: ['jane@example.com'],
    subject: 'Your account',
    body: 'Hello Jane, your account is ready.',
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->accounts->sendAccountEmail('ACC0001', [
    'to' => ['jane@example.com'],
    'subject' => 'Your account',
    'body' => 'Hello Jane, your account is ready.',
]);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.List;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.accounts().sendAccountEmail(
        "ACC0001",
        Map.of(
                "to", List.of("jane@example.com"),
                "subject", "Your account",
                "body", "Hello Jane, your account is ready."));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Accounts.SendAccountEmailAsync(
    "ACC0001",
    new Dictionary<string, object?>
    {
        ["to"] = new List<object?>
        {
            "jane@example.com",
        },
        ["subject"] = "Your account",
        ["body"] = "Hello Jane, your account is ready.",
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.accounts.sendAccountEmail('ACC0001', {
  'to': ['jane@example.com'],
  'subject': 'Your account',
  'body': 'Hello Jane, your account is ready.',
});
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Accounts().SendAccountEmail(context.Background(), "ACC0001", map[string]any{
	"to":      []any{"jane@example.com"},
	"subject": "Your account",
	"body":    "Hello Jane, your account is ready.",
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Send to, subject, body, cc and bcc at the top level of the body, with no wrapper. to needs at least one address and subject is at most 255 characters. This sends real mail. The email then appears in List an account’s emails.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

account_id

string

required

The account's id, such as ACC0001. Not its uuid.

Body

application/json

string[]

required

The recipients. At least one is required.

subject

string

At most 255 characters.

Maximum string length: 255

body

string

string[]

bcc

string[]

Response

The email is sent, and comes back under email.

Guides

API reference

Authorizations

Path Parameters

Body

Response