Delete an email recipient

​

Deletes an email recipient and returns 204 with an empty body. Returns 404 NOT_FOUND when your organization has no email recipient with this id; another organization's id and a recipient that is already deleted return 404 too.

After the delete, lists leave the recipient out and GET /v2/email_recipients/{person_id} returns 404 for it. Both can take a few seconds. Audits that name the person keep that person_id in people[]. To restore the recipient with its original person_id, send POST /v2/email_recipients with the same address.

The API refuses to delete a recipient who is also a dashboard user (a user who signs in to Brellium) and returns 409 EMAIL_RECIPIENT_HAS_USER. details.user_id names the user. Delete that user with DELETE /v2/users/{user_id} first, then delete the recipient.

Path Parameters

  • person_id
    Type: stringFormat: uuid
    required

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

Responses

  • 204

    The email recipient was deleted.

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for delete/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
});

await client.emailRecipients.delete('2a1b0c9d-8e7f-4a6b-9c5d-4e3f2a1b0c9d');
No Body

The email recipient was deleted.

Previous
Update an email recipient
Next
DocumentList