Update an email recipient

​

Replaces an email recipient's first_name, last_name, email and metadata and returns the updated recipient. All four are required. metadata replaces the whole object, so fetch the recipient first when you change one field in it. The API stores the address in lowercase.

Returns 404 NOT_FOUND when your organization has no email recipient with this id; another organization's id and a deleted recipient return 404 too. The API rejects a new address with 409 and one of these codes:

  • EMAIL_RECIPIENT_HAS_USER: the recipient is also a dashboard user (a user who signs in to Brellium), so change its address with PATCH /v2/users/{user_id} instead. details.user_id names the user. The API returns this code even when another recipient also has the new address. To change the other fields, resend the current address; a change of case alone is not a new address.
  • EMAIL_RECIPIENT_EXISTS: another email recipient in your organization has it, ignoring case.

The current address is never a conflict. Lists can take a few seconds to include a changed recipient. For a few seconds after the change, GET /v2/email_recipients/{person_id} can still return the previous version.

Path Parameters

  • person_id
    Type: stringFormat: uuid
    required

    The recipient's person_id, the same id audits show in people[].person_id.

Body·

required
application/json

Every field of the recipient; each replaces the saved value.

The body of PATCH /v2/email_recipients/{person_id}. All four fields are required and replace the saved values.

  • 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
  • application/json
Request Example for patch/v2/email_recipients/{person_id}
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.update('2a1b0c9d-8e7f-4a6b-9c5d-4e3f2a1b0c9d', {
  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 updated email recipient.

Previous
Retrieve an email recipient
Next
Delete an email recipient