Email Record

Beta

POST/v1/core/actions/email-record

Idempotent with Idempotency-Key header. Learn more

Emails a record (invoice, sales order, or purchase order) to its configured recipients and marks the record as sent.

Delivery is asynchronous: the endpoint returns 202 Accepted once the email is queued, so a 202 means the send was accepted, not that it reached the recipients. If the record has no configured recipients the request still succeeds and nothing is sent; in that case a sales order or purchase order is also left unmarked, while an invoice is still marked as sent.

An id that is not one of the account's records of the given type answers 404.

Permissions acceptedValues:invoices:readsales_orders:readpurchase_orders:read

The role behind your API key or agent must grant at least one of these permissions.

idstring

ID of the record to email.

typestringenumValues:invoicesales_orderpurchase_order

The type of record to email.

invoice: emails the invoice to the contacts on its sales order that are set to receive invoice emails.
sales_order: sends an order acknowledgement to the order's acknowledgement recipients.
purchase_order: sends the purchase order submission to the order's submission recipients.

Responses

202

Successful response for Email Record

Email Record

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const response = await client.core.actions.emailRecord({ id: 'iv_m982ezb0fgp7', type: 'invoice' });

console.log(response);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const response = await client.core.actions.emailRecord({ id: 'iv_m982ezb0fgp7', type: 'invoice' });

console.log(response);

202 example

{}

{}

Email Record

Authorization

Request Body

Responses