Skip to content

Update Primary Email Address

workmail_update_primary_email_address R Documentation

Updates the primary email for a user, group, or resource

Description

Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.

Usage

workmail_update_primary_email_address(OrganizationId, EntityId, Email)

Arguments

OrganizationId

[required] The organization that contains the user, group, or resource to update.

EntityId

[required] The user, group, or resource to update.

The identifier can accept UseriD, ResourceId, or GroupId, Username, Resourcename, or Groupname, or email. The following identity formats are available:

  • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

  • Email address: entity@domain.tld

  • Entity name: entity

Email

[required] The value of the email to be updated as primary.

Value

An empty list.

Request syntax

svc$update_primary_email_address(
  OrganizationId = "string",
  EntityId = "string",
  Email = "string"
)