Email a document

cURL

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

from exsited import build_client

client = build_client()

response = client.communications.send_email(
    {
        "invoice": "INV-0001",
        "to": ["jane@example.com"],
        "subject": "Your invoice",
        "body": "Hello Jane, here is your invoice.",
    }
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.communications.sendEmail({
    invoice: 'INV-0001',
    to: ['jane@example.com'],
    subject: 'Your invoice',
    body: 'Hello Jane, here is your invoice.',
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->communications->sendEmail([
    'invoice' => 'INV-0001',
    'to' => ['jane@example.com'],
    'subject' => 'Your invoice',
    'body' => 'Hello Jane, here is your invoice.',
]);
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.communications().sendEmail(
        Map.of(
                "invoice", "INV-0001",
                "to", List.of("jane@example.com"),
                "subject", "Your invoice",
                "body", "Hello Jane, here is your invoice."));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Communications.SendEmailAsync(new Dictionary<string, object?>
{
    ["invoice"] = "INV-0001",
    ["to"] = new List<object?>
    {
        "jane@example.com",
    },
    ["subject"] = "Your invoice",
    ["body"] = "Hello Jane, here is your invoice.",
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.communications.sendEmail({
  'invoice': 'INV-0001',
  'to': ['jane@example.com'],
  'subject': 'Your invoice',
  'body': 'Hello Jane, here is your invoice.',
});
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.Communications().SendEmail(context.Background(), map[string]any{
	"invoice": "INV-0001",
	"to":      []any{"jane@example.com"},
	"subject": "Your invoice",
	"body":    "Hello Jane, here is your invoice.",
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

POST

communications

send_email

cURL

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

from exsited import build_client

client = build_client()

response = client.communications.send_email(
    {
        "invoice": "INV-0001",
        "to": ["jane@example.com"],
        "subject": "Your invoice",
        "body": "Hello Jane, here is your invoice.",
    }
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.communications.sendEmail({
    invoice: 'INV-0001',
    to: ['jane@example.com'],
    subject: 'Your invoice',
    body: 'Hello Jane, here is your invoice.',
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->communications->sendEmail([
    'invoice' => 'INV-0001',
    'to' => ['jane@example.com'],
    'subject' => 'Your invoice',
    'body' => 'Hello Jane, here is your invoice.',
]);
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.communications().sendEmail(
        Map.of(
                "invoice", "INV-0001",
                "to", List.of("jane@example.com"),
                "subject", "Your invoice",
                "body", "Hello Jane, here is your invoice."));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Communications.SendEmailAsync(new Dictionary<string, object?>
{
    ["invoice"] = "INV-0001",
    ["to"] = new List<object?>
    {
        "jane@example.com",
    },
    ["subject"] = "Your invoice",
    ["body"] = "Hello Jane, here is your invoice.",
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.communications.sendEmail({
  'invoice': 'INV-0001',
  'to': ['jane@example.com'],
  'subject': 'Your invoice',
  'body': 'Hello Jane, here is your invoice.',
});
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.Communications().SendEmail(context.Background(), map[string]any{
	"invoice": "INV-0001",
	"to":      []any{"jane@example.com"},
	"subject": "Your invoice",
	"body":    "Hello Jane, here is your invoice.",
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

The body names one of invoice, purchase_invoice, account_statement or payment, holding that document’s id, beside to, cc, bcc, subject, body and template.

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.

Body

application/json

Name one document to email, beside the recipients and content.

invoice

string

The id of the invoice to email, such as INV-0001. Send one of invoice, purchase_invoice, account_statement or payment.

purchase_invoice

string

The id of the purchase invoice to email.

account_statement

string

The id of the account statement to email.

payment

string

The id of the payment to email.

any

The recipients.

any

Copy recipients.

bcc

any

Blind copy recipients.

subject

string

The email's subject.

body

string

The email's body.

template

any

The email template to use.

Response

200

The email is sent.

Guides

API reference

Authorizations

Body

Response