EmailRecipient
A person who receives audit result emails for your organization. Audits that name the person carry the same person_id.
- createdType: stringFormat: date-time
_at requiredWhen the recipient was created (RFC 3339).
- emailType: string | nullrequired
The recipient's email address, where audit result emails go. The API stores it in lowercase when you create or update the recipient.
nullwhen the recipient has no address on file. - firstType: string
_name requiredThe recipient's first name.
- lastType: string
_name requiredThe recipient's last name.
- metadataType: objectrequiredProperties: 1
A JSON object you attach to the recipient, such as roster or team labels.
{}when not set. - objectenumconst:email_recipientrequired
Always
email_recipient. - personType: stringFormat: uuid
_id requiredThe id of the email recipient. Audits that name this person show it in
people[].person_id. - updatedType: stringFormat: date-time
_at requiredWhen the recipient was last changed (RFC 3339).