Email templates

Templates behind the emails NolaPro sends. action is the key that identifies which email a template is for; name is the human label. No lastchangedate, so no modifiedsince.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
action	string(20)	The code this resource is keyed by. Matching is case insensitive.
name	string(200)	Human label for the template.
subject	string(255)	Subject line.
body	text	Template body.
cancel	boolean	True once cancelled. Cancelled rows stay referenced by history.
externalid	string(100)	Your own key for this email templates. Scoped to your company.

Endpoints#

POST/emailtemplates/batch 207

Create many.

Always answers 207, one result per item.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
action	string(20)	The code this resource is keyed by. Matching is case insensitive.
name	string(200)	Human label for the template.
subject	string(255)	Subject line.
body	text	Template body.
cancel	boolean	True once cancelled. Cancelled rows stay referenced by history.
externalid	string(100)	Your own key for this email templates. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/emailtemplates/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "id": 2,
        "action": "invoice",
        "name": "Invoice email",
        "subject": "",
        "body": "",
        "cancel": false
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/emailtemplates/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'id' => 2,
      'action' => 'invoice',
      'name' => 'Invoice email',
      'subject' => '',
      'body' => '',
      'cancel' => false,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/emailtemplates/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "id": 2,
            "action": "invoice",
            "name": "Invoice email",
            "subject": "",
            "body": "",
            "cancel": False,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/emailtemplates/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        id: 2,
        action: "invoice",
        name: "Invoice email",
        subject: "",
        body: "",
        cancel: false,
      },
    ]),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new[] {
    new {
        id = 2,
        action = "invoice",
        name = "Invoice email",
        subject = "",
        body = "",
        cancel = false,
    },
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/emailtemplates/batch") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

GET/emailtemplates 200403

List email templates.

Requires scope setup:read.

Parameters

Name	In	Type	Notes
name	query	string	name. Partial match, case-insensitive.
action	query	string	Partial match, case insensitive.
cancel	query	string	Defaults to `false`. Pass `true` for cancelled only, or `any`.
externalid	query	string	Exact match on your own key. Scoped to your company.
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
403	insufficient_scope	Token lacks `emailtemplates:read`.

curl \
  'https://acme.nolapro.com/!/api/v2/emailtemplates' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/emailtemplates');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/emailtemplates",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/emailtemplates',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/emailtemplates");
res.EnsureSuccessStatusCode();

POST/emailtemplates 201400409

Create.

Requires scope setup:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
action	string(20)	The code this resource is keyed by. Matching is case insensitive.
name	string(200)	Human label for the template.
subject	string(255)	Subject line.
body	text	Template body.
cancel	boolean	True once cancelled. Cancelled rows stay referenced by history.
externalid	string(100)	Your own key for this email templates. Scoped to your company.

When it fails

Status	Code	Meaning
400	invalid_request	A required field was missing or invalid.
409	duplicate	That code is already in use.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/emailtemplates' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 2,
    "action": "invoice",
    "name": "Invoice email",
    "subject": "",
    "body": "",
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/emailtemplates');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 2,
    'action' => 'invoice',
    'name' => 'Invoice email',
    'subject' => '',
    'body' => '',
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/emailtemplates",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 2,
        "action": "invoice",
        "name": "Invoice email",
        "subject": "",
        "body": "",
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/emailtemplates',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 2,
      action: "invoice",
      name: "Invoice email",
      subject: "",
      body: "",
      cancel: false,
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    id = 2,
    action = "invoice",
    name = "Invoice email",
    subject = "",
    body = "",
    cancel = false,
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/emailtemplates") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 201

{
    "id": 2,
    "action": "invoice",
    "name": "Invoice email",
    "subject": "",
    "body": "",
    "cancel": false
}

GET/emailtemplates/{id} 200404

Retrieve one record.

Requires scope setup:read.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl \
  'https://acme.nolapro.com/!/api/v2/emailtemplates/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/emailtemplates/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/emailtemplates/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/emailtemplates/104',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/emailtemplates/104");
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 2,
    "action": "invoice",
    "name": "Invoice email",
    "subject": "",
    "body": "",
    "cancel": false
}

PATCH/emailtemplates/{id} 200404409

Update.

Requires scope setup:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
action	string(20)	The code this resource is keyed by. Matching is case insensitive.
name	string(200)	Human label for the template.
subject	string(255)	Subject line.
body	text	Template body.
cancel	boolean	True once cancelled. Cancelled rows stay referenced by history.
externalid	string(100)	Your own key for this email templates. Scoped to your company.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.
409	stale_record	`If-Match` did not match.

curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/emailtemplates/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 2,
    "action": "invoice",
    "name": "Invoice email",
    "subject": "",
    "body": "",
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/emailtemplates/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 2,
    'action' => 'invoice',
    'name' => 'Invoice email',
    'subject' => '',
    'body' => '',
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/emailtemplates/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 2,
        "action": "invoice",
        "name": "Invoice email",
        "subject": "",
        "body": "",
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/emailtemplates/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 2,
      action: "invoice",
      name: "Invoice email",
      subject: "",
      body: "",
      cancel: false,
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    id = 2,
    action = "invoice",
    name = "Invoice email",
    subject = "",
    body = "",
    cancel = false,
};

var req = new HttpRequestMessage(HttpMethod.Patch,
    "https://acme.nolapro.com/!/api/v2/emailtemplates/104") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 2,
    "action": "invoice",
    "name": "Invoice email",
    "subject": "",
    "body": "",
    "cancel": false
}

DELETE/emailtemplates/{id} 200403404

Cancel.

Sets the cancel flag. Nothing is removed.

Requires scope setup:cancel.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

When it fails

Status	Code	Meaning
403	insufficient_scope	Needs `emailtemplates:cancel`.
404	not_found	No record with that id.

curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/emailtemplates/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/emailtemplates/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'DELETE',
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.delete(
    "https://acme.nolapro.com/!/api/v2/emailtemplates/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/emailtemplates/104',
  {
    method: 'DELETE',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var req = new HttpRequestMessage(HttpMethod.Delete,
    "https://acme.nolapro.com/!/api/v2/emailtemplates/104");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 2,
    "action": "invoice",
    "name": "Invoice email",
    "subject": "",
    "body": "",
    "cancel": false
}

Webhook subscriptions →

Subscriptions that push events to your server instead of you polling for them. A subscription belongs to the token that created it and only ever delivers events that token has the scope to read. The envelope, signature verification and the retry schedule are in - read that first; this page is the subscription object and the event catalogue.

Request log →

What this token has been doing. Useful when a call failed hours ago and nobody kept the response.