Mailbox API — Account

APIs & Tools

The Mailbox API is available starting with Axigen X4 (10.4).

Info

Get

Response

Contact Information

Get

Response

Update

Request body (JSON)

Name

Type

Required

Values

Description

title

String

The current user's title. e.g. "Dr.", "Prof.", "Mr.", "Ms."

Default value: ““

firstName

String

The current user's first name

Default value: ““

middleName

String

The current user's middle name

Default value: ““

lastName

String

The current user's last name

Default value: ““

suffix

String

The current user's name suffix. e.g. "Jr.", "Sr.", "I", "II"

Default value: ““

Response

If successful, the response will be empty.

Aliases

List

This endpoint returns the permanent alias email addresses of the user – the email addresses the user can receive emails on. The list is a combination between domain aliases and account aliases; by default, these aliases can also be used for authentication – this can be controlled through the allowAliasLogins admin level configuration.

Response

Temporary Aliases

List

Response

Create

Response

Delete

URL parameters

Name

Type

Description

id

String

The ID of the temporary alias

Response

If successful, the response will be empty.

Signatures

List

Response

Create

Request body (JSON)

Name

Type

Required

Values

Description

name

String

*

 

The signature name

type

String

*

“html”, “text”

The signature type

body

String

*

The signature body

Response

Get

URL parameters

Name

Type

Description

id

String

The signature ID

Response

Update

URL parameters

Name

Type

Description

id

String

The signature ID

Request body (JSON)

Name

Type

Required

Values

Description

name

String

 

The new signature name

type

String

“html”, “text”

The new signature type

body

String

The new signature body

Response

If successful, the response will be empty.

Delete

URL parameters

Name

Type

Description

id

String

The signature ID

Response

If successful, the response will be empty.

Avatar

Get

Response

The avatar image associated with the account.

Update

Request body

Include the avatar image as a multipart/form-data HTTP body part.

Response

If successful, the response will be empty.

Delete

Response

If successful, the response will be empty.