Email addresses

Update Email Address

Changed on

Gives the mailbox to a team member, or shares it with the account, under a new password. A mailbox that had an owner starts empty, because its earlier mail is private to that owner; mail apps sync it again from the start.

patch/email_addresses/{id}

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/email_addresses/{id}
  • Auth: HTTP bearer

Request body

user_idstring nullable

ID of the team member who owns the mailbox, prefixed user_. Only they can read it or send from it. Leave it out, or pass null, to share the mailbox with the account. Giving an owned mailbox to someone else empties it: the owner's mail is never shown to anyone else.

Example request

{
  "user_id": "user_xxxxxxxxxxxxxx"
}

Response

Email address updated

account_idstring required

ID of the account the address belongs to, prefixed biz_.

addressstring required

The full address in lowercase, such as support@example.com.

created_atstring required

When the address was created, as an ISO 8601 timestamp.

domain_idstring required

ID of the domain the address is on, prefixed dom_.

idstring required

Email address ID, prefixed emaddr_.

passwordstring nullable required

The password mail apps sign in to the mailbox with over IMAP and SMTP, using the address as the username. null unless you can use the mailbox: you own it, or nobody owns it and you have email:read and email:send.

updated_atstring required

When the address was last updated, as an ISO 8601 timestamp.

user_idstring nullable required

ID of the team member who owns the mailbox, prefixed user_. Only they can read it or send from it. null when the whole account shares it.

Example response

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "address": "marcus@shinetime.example",
  "created_at": "2026-01-01T12:00:00.000Z",
  "domain_id": "whopappdomain0000001",
  "id": "emaddr_xxxxxxxxxxxxxx",
  "password": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "user_id": "user_xxxxxxxxxxxxxx"
}

Changes