Create an email recipient

​

Creates an email recipient and returns it with 201. An email recipient is a person named on your audits, such as a provider, with the email address that receives their audit result emails. Audits show the recipient's person_id in people[].person_id.

first_name, last_name, email and metadata are all required; send {} as metadata when you have nothing to attach. The API stores the address in lowercase. If another email recipient in your organization has the address, ignoring case, the API returns 409 EMAIL_RECIPIENT_EXISTS. A person who is not an email recipient, such as a patient, doesn't cause this conflict.

If a deleted recipient has the address, the API restores it instead. The restored recipient keeps its person_id and created_at, so audits still point at it, and takes every other field from your request. When several deleted recipients have the address, the API restores the most recently changed one. If a dashboard user (a user who signs in to Brellium) shares the recipient's person_id, the user still shares it after the restore.

GET /v2/email_recipients/{person_id} and lists can take a few seconds to include the new recipient.

Body·

required
application/json

Every field of the new recipient.

The body of POST /v2/email_recipients. All four fields are required.

  • email
    Type: stringFormat: email
    required

    The recipient's email address, where audit result emails go. The API stores it in lowercase. If another email recipient in your organization has the address, ignoring case, the request fails with 409 EMAIL_RECIPIENT_EXISTS. The API rejects addresses at brellium.com or its subdomains with 400 VALIDATION_ERROR.

  • first_name
    Type: string
    min length:  
    1
    max length:  
    255
    required

    The recipient's first name, 1 to 255 characters.

  • last_name
    Type: string
    min length:  
    1
    max length:  
    255
    required

    The recipient's last name, 1 to 255 characters.

  • metadata
    Type: object
    required

    A JSON object to attach to the recipient, such as roster or team labels. It replaces any saved object completely, so {} clears it.

    Properties: 1

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/v2/email_recipients
import BrelliumClient from '@brellium/api-client';

const client = new BrelliumClient({
  oAuth2: process.env['BRELLIUM_ACCESS_TOKEN'], // defaults to the BRELLIUM_ACCESS_TOKEN env var
});

const emailRecipient = await client.emailRecipients.create({
  first_name: 'Jordan',
  last_name: 'Rivera',
  email: 'jordan.rivera@clinic.example',
  metadata: { roster_team: 'North clinic' },
});

console.log(emailRecipient);

{
  "person_id": "2a1b0c9d-8e7f-4a6b-9c5d-4e3f2a1b0c9d",
  "object": "email_recipient",
  "first_name": "Jordan",
  "last_name": "Rivera",
  "email": "jordan.rivera@clinic.example",
  "metadata": {
    "roster_team": "North clinic"
  },
  "created_at": "2026-09-01T12:00:00.000Z",
  "updated_at": "2026-09-01T12:00:00.000Z"
}

The new email recipient, or the restored one with its original person_id.

Previous
List email recipients
Next
Retrieve an email recipient