v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB

Email Addresses

Create an email address

Create a new email address

post/email_addresses

Request body

user_idstring required

The ID representing the user

email_addressstring required

The new email address. Must adhere to the RFC 5322 specification for email address format.

verifiedboolean nullable

When created, the email address will be marked as verified.

primaryboolean nullable

Create this email address as the primary email address for the user. Default: false, unless it is the first email address.

notify_primary_email_address_changedboolean nullable

If set to true and the email address is created as 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