Set Email Sender

Beta

PUT/v1/messaging/email-sender

This endpoint is idempotent. Learn more

Sets the address your order, invoice, and statement emails are sent from, replacing any address already configured.

The domain must be verified first. Emails about someone's OpenMRP account — password resets, verification, plan changes — continue to send from the platform address.

Permissions requiredValues:messaging:update

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

email_domain_idstring

The verified email domain to send from.

local_partstring

The mailbox name before the @, for example orders.

from_nameoptional string

The name shown in a mail client's sender column. When unset, mail shows the bare address.

reply_tooptional string

Where customer replies are delivered. When unset, replies go to the sending address.

idstring

Email sender ID.

objectstringenumValues:email_sender

Resource type identifier.

email_domain_idstring

The verified email domain this address belongs to.

local_partstring

The mailbox name before the @.

addressstring

The full sending address.

from_namestringnullable

The name shown in a mail client's sender column. When unset, mail shows the bare address.

reply_tostringnullable

Where customer replies are delivered. When unset, replies go to the sending address.

domainstring

The domain name the address sends from.

domain_statusstringenumValues:pendingverifiedfailed

Verification status of the underlying domain.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Set Email Sender

Set Email Sender

import OpenMRP from '@openmrp/sdk';

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

const emailSender = await client.messaging.emailSender.update({
  email_domain_id: 'emdom_2rk3omr8vshb',
  local_part: 'orders',
  from_name: 'Acme Inc.',
});

console.log(emailSender.id);

import OpenMRP from '@openmrp/sdk';

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

const emailSender = await client.messaging.emailSender.update({
  email_domain_id: 'emdom_2rk3omr8vshb',
  local_part: 'orders',
  from_name: 'Acme Inc.',
});

console.log(emailSender.id);

200 example

{
  "id": "emsx_4bk9pmt2wvqd",
  "object": "email_sender",
  "email_domain_id": "emdom_2rk3omr8vshb",
  "local_part": "orders",
  "address": "orders@support.acme.com",
  "from_name": null,
  "reply_to": null,
  "domain": "support.acme.com",
  "domain_status": "verified",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "emsx_4bk9pmt2wvqd",
  "object": "email_sender",
  "email_domain_id": "emdom_2rk3omr8vshb",
  "local_part": "orders",
  "address": "orders@support.acme.com",
  "from_name": null,
  "reply_to": null,
  "domain": "support.acme.com",
  "domain_status": "verified",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Set Email Sender

Authorization

Request Body

Returns

Responses