Sign in
Email Addresses

Update an email address

Updates an email address.

patch/email_addresses/{email_address_id}

Path parameters

email_address_idstring required

The ID of the email address to update

Request body

verifiedboolean nullable

The email address will be marked as verified.

primaryboolean nullable

Set this email address as the primary email address for the user.

notify_primary_email_address_changedboolean nullable

If set to true and this update makes the email address the user's new primary, the previous primary email address is notified of the change. By default, no notification is sent.

Response

Success

idstring
object'email_address' required

String representing the object's type. Objects of the same type share the same value.

email_addressstring required
reservedboolean required
matches_sso_connectionboolean

Indicates whether this email address domain matches an active enterprise connection.

created_atinteger required

Unix timestamp of creation

updated_atinteger required

Unix timestamp of creation

Changes

Changed in 2 of the 15 revisions of this API.2

  • 405105aa16c31See the full diff
    • ○

      added the new optional request property notify_primary_email_address_changed

      new-optional-request-property

  • 11bb1ccf4b7d1See the full diff
    • ○

      added the optional property verification/oneOf[verification_otp]/channel to the response with the 200 status

      response-optional-property-added