Skip to main content
POST
Create Email Address

Autorisationer

Authorization
string
header
påkrævet

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

email:manage

Overskrifter

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Eksempel:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Krop

application/json
address
string
påkrævet

The full address, such as support@example.com. The part before the @ can use letters, numbers, dots, dashes, underscores and plus signs.

Eksempel:

"marcus@shinetime.example"

account_id
string

Account ID, prefixed biz_. Required for user credentials; otherwise defaults to the credential's account.

user_id
string | null

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.

Eksempel:

"user_xxxxxxxxxxxxxx"

Svar

Email address created

account_id
string
påkrævet

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

Eksempel:

"biz_xxxxxxxxxxxxxx"

address
string
påkrævet

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

Eksempel:

"marcus@shinetime.example"

created_at
string
påkrævet

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

Eksempel:

"2026-01-01T12:00:00.000Z"

domain_id
string
påkrævet

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

Eksempel:

"whopappdomain0000001"

id
string
påkrævet

Email address ID, prefixed emaddr_.

Eksempel:

"emaddr_xxxxxxxxxxxxxx"

password
string | null
påkrævet

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.

Eksempel:

"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

updated_at
string
påkrævet

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

Eksempel:

"2026-01-01T12:00:00.000Z"

user_id
string | null
påkrævet

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.

Eksempel:

"user_xxxxxxxxxxxxxx"