Email Addresses API

A mailbox can belong to one team member, who alone can read it and send from it. Or the account can share it, and then email:read and email:send decide who can use it. Use the Email addresses API to create, list, reassign and delete mailboxes. You can read the password that mail apps sign in with. You can also download a configuration profile that adds the mailbox to Mail on Apple devices. Deleting an address keeps its mail, and creating it again in the same account brings the mailbox back.

Endpoints

Endpoint	Request
List Email Addresses	GET `/email_addresses`
Retrieve Email Address	GET `/email_addresses/{id}`
Download Email Address Configuration Profile	GET `/email_addresses/{id}/mobileconfig`
Create Email Address	POST `/email_addresses`
Reset Email Address Password	POST `/email_addresses/{id}/reset_password`
Update Email Address	PATCH `/email_addresses/{id}`
Delete Email Address	DELETE `/email_addresses/{id}`

Attributes

string

required

Email address ID, prefixed emaddr_.

string

required

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

string

required

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

string

required

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

string

required

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

string | null

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.

string

required

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

string | null

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.

EmailAddress

{
	"id": "emaddr_xxxxxxxxxxxxxx",
	"address": "support@shinetime.example",
	"account_id": "biz_xxxxxxxxxxxxxx",
	"domain_id": "dom_xxxxxxxxxxxxxx",
	"user_id": null,
	"password": null,
	"created_at": "2026-08-20T13:05:00.000Z",
	"updated_at": "2026-08-20T13:05:00.000Z"
}

Introduction

Reference

Core Resources

Payments

Money

Commerce

Websites

Ads

Analytics

Communication

Partners

Workforce

Media

Developer

Email Addresses API

Endpoints

Attributes

​Endpoints

​Attributes

Endpoints

Attributes