UpdateEmailRecipient

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