Send a message

curl --request POST \
  --url https://bud.noetive.io/v1/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": [
    "<string>"
  ],
  "cc": [
    "<string>"
  ],
  "bcc": [
    "<string>"
  ],
  "from": "<string>",
  "on_behalf_of": "<string>",
  "subject": "<string>",
  "text": "<string>",
  "html": "<string>",
  "in_reply_to": "<string>",
  "reply_all": true,
  "idempotency_key": "<string>"
}
'

import requests

url = "https://bud.noetive.io/v1/send"

payload = {
    "to": ["<string>"],
    "cc": ["<string>"],
    "bcc": ["<string>"],
    "from": "<string>",
    "on_behalf_of": "<string>",
    "subject": "<string>",
    "text": "<string>",
    "html": "<string>",
    "in_reply_to": "<string>",
    "reply_all": True,
    "idempotency_key": "<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>'],
    cc: ['<string>'],
    bcc: ['<string>'],
    from: '<string>',
    on_behalf_of: '<string>',
    subject: '<string>',
    text: '<string>',
    html: '<string>',
    in_reply_to: '<string>',
    reply_all: true,
    idempotency_key: '<string>'
  })
};

fetch('https://bud.noetive.io/v1/send', 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://bud.noetive.io/v1/send",
  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>'
    ],
    'cc' => [
        '<string>'
    ],
    'bcc' => [
        '<string>'
    ],
    'from' => '<string>',
    'on_behalf_of' => '<string>',
    'subject' => '<string>',
    'text' => '<string>',
    'html' => '<string>',
    'in_reply_to' => '<string>',
    'reply_all' => true,
    'idempotency_key' => '<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://bud.noetive.io/v1/send"

	payload := strings.NewReader("{\n  \"to\": [\n    \"<string>\"\n  ],\n  \"cc\": [\n    \"<string>\"\n  ],\n  \"bcc\": [\n    \"<string>\"\n  ],\n  \"from\": \"<string>\",\n  \"on_behalf_of\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"text\": \"<string>\",\n  \"html\": \"<string>\",\n  \"in_reply_to\": \"<string>\",\n  \"reply_all\": true,\n  \"idempotency_key\": \"<string>\"\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://bud.noetive.io/v1/send")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": [\n    \"<string>\"\n  ],\n  \"cc\": [\n    \"<string>\"\n  ],\n  \"bcc\": [\n    \"<string>\"\n  ],\n  \"from\": \"<string>\",\n  \"on_behalf_of\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"text\": \"<string>\",\n  \"html\": \"<string>\",\n  \"in_reply_to\": \"<string>\",\n  \"reply_all\": true,\n  \"idempotency_key\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://bud.noetive.io/v1/send")

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  \"cc\": [\n    \"<string>\"\n  ],\n  \"bcc\": [\n    \"<string>\"\n  ],\n  \"from\": \"<string>\",\n  \"on_behalf_of\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"text\": \"<string>\",\n  \"html\": \"<string>\",\n  \"in_reply_to\": \"<string>\",\n  \"reply_all\": true,\n  \"idempotency_key\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "state": "queued",
  "message": "<string>",
  "reason": "<string>",
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

Send

Send a message

Compose and send, or reply. The reply form computes recipients from the message being replied to rather than making the caller reconstruct them from a rendering: a rendering is partly what a sender chose.

A send is subject to the mailbox’s limits and policy. Three outcomes are normal and distinguishable: it is queued, it is held, or it is refused with 422 policy_refused and guard naming the rule that fired. Neither a hold nor a refusal is worth retrying unchanged. Retrying is how one held message becomes five.

No agent can approve a held message in this deployment (see hold.update), so a hold ends in rejection when it expires, after 72 hours unless the account set otherwise. A mailbox created on a customer’s first request has nobody to approve its mail, so what would be held for it is refused instead, and the agent learns at once which rule fired.

Pass idempotency_key on every send. Without one, a timeout you retry is a second message.

POST

send

Send a message

curl --request POST \
  --url https://bud.noetive.io/v1/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": [
    "<string>"
  ],
  "cc": [
    "<string>"
  ],
  "bcc": [
    "<string>"
  ],
  "from": "<string>",
  "on_behalf_of": "<string>",
  "subject": "<string>",
  "text": "<string>",
  "html": "<string>",
  "in_reply_to": "<string>",
  "reply_all": true,
  "idempotency_key": "<string>"
}
'

import requests

url = "https://bud.noetive.io/v1/send"

payload = {
    "to": ["<string>"],
    "cc": ["<string>"],
    "bcc": ["<string>"],
    "from": "<string>",
    "on_behalf_of": "<string>",
    "subject": "<string>",
    "text": "<string>",
    "html": "<string>",
    "in_reply_to": "<string>",
    "reply_all": True,
    "idempotency_key": "<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>'],
    cc: ['<string>'],
    bcc: ['<string>'],
    from: '<string>',
    on_behalf_of: '<string>',
    subject: '<string>',
    text: '<string>',
    html: '<string>',
    in_reply_to: '<string>',
    reply_all: true,
    idempotency_key: '<string>'
  })
};

fetch('https://bud.noetive.io/v1/send', 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://bud.noetive.io/v1/send",
  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>'
    ],
    'cc' => [
        '<string>'
    ],
    'bcc' => [
        '<string>'
    ],
    'from' => '<string>',
    'on_behalf_of' => '<string>',
    'subject' => '<string>',
    'text' => '<string>',
    'html' => '<string>',
    'in_reply_to' => '<string>',
    'reply_all' => true,
    'idempotency_key' => '<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://bud.noetive.io/v1/send"

	payload := strings.NewReader("{\n  \"to\": [\n    \"<string>\"\n  ],\n  \"cc\": [\n    \"<string>\"\n  ],\n  \"bcc\": [\n    \"<string>\"\n  ],\n  \"from\": \"<string>\",\n  \"on_behalf_of\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"text\": \"<string>\",\n  \"html\": \"<string>\",\n  \"in_reply_to\": \"<string>\",\n  \"reply_all\": true,\n  \"idempotency_key\": \"<string>\"\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://bud.noetive.io/v1/send")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": [\n    \"<string>\"\n  ],\n  \"cc\": [\n    \"<string>\"\n  ],\n  \"bcc\": [\n    \"<string>\"\n  ],\n  \"from\": \"<string>\",\n  \"on_behalf_of\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"text\": \"<string>\",\n  \"html\": \"<string>\",\n  \"in_reply_to\": \"<string>\",\n  \"reply_all\": true,\n  \"idempotency_key\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://bud.noetive.io/v1/send")

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  \"cc\": [\n    \"<string>\"\n  ],\n  \"bcc\": [\n    \"<string>\"\n  ],\n  \"from\": \"<string>\",\n  \"on_behalf_of\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"text\": \"<string>\",\n  \"html\": \"<string>\",\n  \"in_reply_to\": \"<string>\",\n  \"reply_all\": true,\n  \"idempotency_key\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "state": "queued",
  "message": "<string>",
  "reason": "<string>",
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "request_id": "<string>",
    "retry_after_ms": 123,
    "version": "<string>",
    "current": {}
  }
}

Authorizations

Authorization

string

header

required

Bearer token for one agent. Pass as Authorization: Bearer <token>.

A token is shown once when it is issued and is not recoverable afterwards. Treat it as a secret: it reaches one agent's mail, calendar and contacts, and anything a grant has extended to it.

Body

application/json

string[]

required

Recipients.

string[]

bcc

string[]

from

string

Which of the agent's addresses to send as. Empty takes its primary address.

on_behalf_of

string

Send as another agent, which needs a grant. The message then names both, so a recipient can see who wrote it and who it is from, and policy usually holds it for approval, which is the point of the distinction.

subject

string

text

string

The plain-text body.

html

string

An alternative to text, not a replacement for it. A message with no plain part is one the reader on the other side has to render before it can read it.

in_reply_to

string

The message this replies to. It is what puts the reply in a conversation.

reply_all

boolean

Compute recipients from the message being replied to, minus the caller's own addresses.

idempotency_key

string

Strongly recommended. A repeat with the same key returns the first attempt's result rather than sending a second message.

Response

The send was accepted, held, or refused. Read state: a 200 here does not mean the message left.

state

enum<string>

queued means accepted for delivery. held means it is waiting on an approval and must not be retried. rejected means it is not sent.

Available options:

queued,

held,

rejected

message

string

The message's identifier, once it has one.

reason

string

Why, when it is held or rejected.

error

object

Show child attributes

Discovery

Mail

Send

Calendar

Contacts

Attachments

Events

Health

Send a message

Authorizations

Body

Response