POpocketflows
Email addresses

Update an email address

Changed on
post/email_addresses/{id}

Request

Path parameters

idstring required

The ID of the email address

Request body

display_namestring

The display name of the email address

reply_tostring nullable

The reply-to address of the email address

usernamestring

The username of the email address - the part that comes before the @

email_addressstring

The full email address. Only secret keys and dashboard sessions may change it. Cannot be combined with username, and cannot be changed for email addresses on a custom domain or Pocketflows-provisioned email addresses, or to a domain that is reserved or already set up as a custom domain. Sending fails if the new domain isn't authenticated with the email provider.

Response

The updated EmailAddress object

idstring required

The ID of the email address

email_addressstring required

The email address

display_namestring required

The display name of the email address

reply_tostring nullable required

The reply-to address

businessstring nullable required

The business associated with this email address

one_offboolean required

Whether the email address is one-off

custom_domainstring nullable required

The custom domain associated with this email address

Changes