Version: Insiders

Create Mailbox

The Easylife 365 Mail API supports the provisioning of three types of mailboxes:

Shared Mailboxes: Mailboxes that can be accessed by multiple users, typically used for shared email addresses like shared-mailbox@company.com.
Equipment Mailboxes: Mailboxes used to manage resources such as projectors, vehicles, or other equipment.
Room Mailboxes: Mailboxes used to manage meeting rooms or other physical spaces, allowing users to book them via calendar invites.

Create a new mailbox with the specified properties.

HTTP Request

POST https://api.easylife365.cloud/mail/v1/mailboxes/
Content-Type: application/json

HTTP Request Headers

Header	Value
Authorization	Bearer token. (Required)
Content-Type	application/json

Request Body

Mailbox Properties Table

Property	Type	Description & Example
`name`	`string`	Unique identifier for the mailbox. Example: `"support"`. Required
`displayName`	`string`	Human-readable display name. Example: `"Customer Support"`. Required
`templateId`	`string (UUID)`	Template identifier for predefined mailbox template. Ensure that the type of template corresponds to the mailbox type being provisioned. Example: `"fc6ffbd8-f7f0-4c05-b707-227d233b9e1b"`. Required
`permissions`	`object`	Defines user permissions for the mailbox. Required
`metadata`	`object`	Key-value pairs for custom metadata. Example: `{ "department": "HR", "createdBy": "Admin" }`. Optional
`capacity`	`integer`	Mailbox storage capacity in MB. Example: `5000`. Optional
`state`	`string`	Current state of the mailbox. Example: `"active"`. Optional
`streetAddress`	`string`	Physical address (if applicable). Example: `"123 Corporate Blvd"`. Optional
`officeLocation`	`string`	Office location name. Example: `"HQ - Floor 5"`. Optional
`companyName`	`string`	Associated company name. Example: `"Acme Corp"`. Optional
`postalCode`	`string`	Postal code of the location. Example: `"10001"`. Optional
`city`	`string`	City of the mailbox location. Example: `"New York"`. Optional
`country`	`string`	Country name. Example: `"USA"`. Optional
`businessPhones`	`array<string>`	List of business phone numbers. Example: `["+1-800-555-1234", "+1-800-555-5678"]`. Optional
`phone`	`string`	Primary contact phone number. Example: `"+1-800-555-5678"`. Optional
`department`	`string`	Department name associated with the mailbox. Example: `"HR"`. Optional
`primaryOwner`	`string (UUID)`	UUID of the primary owner. Example: `"49cf935a-284f-4c84-8df7-a5b11f1be527"`. Optional
`secondaryOwner`	`string (UUID)`	UUID of the secondary owner. Example: `"6a95c23b-cbb3-4f06-9b05-5e96ac65c78c"`. Optional
`automaticReply`	`string`	Auto-reply message for the mailbox. Example: `"Thank you for contacting us."`. Optional
`isAllowAutomaticReplyOverride`	`boolean`	If `true`, allows users to override auto-reply. Example: `true`. Optional
`domain`	`string`	Domain of the mailbox. Example: `"company.com"`. Optional
`audioDeviceName`	`string`	Associated audio device (for room/equipment). Example: `"Bose Speaker System"`. Optional
`displayDeviceName`	`string`	Associated display device. Example: `"Samsung 85-inch Display"`. Optional
`tags`	`array<string>`	Tags for mailbox classification. Example: `["support", "helpdesk"]`. Optional
`videoDeviceName`	`string`	Associated video device. Example: `"Logitech Video Conference Camera"`. Optional
`isWheelChairAccessible`	`boolean`	If `true`, indicates wheelchair accessibility. Example: `true`. Optional
`roomMailboxMetadata`	`object`	Room properties metadata. Optional
`hideFromGAL`	`boolean`	If `true`, hides mailbox from the Global Address List (GAL). Example: `false`. Optional
`notes`	`string`	Additional notes for mailbox usage. Example: `"This mailbox is monitored by the HR team."`. Optional
`reason`	`string`	Reason for creating the mailbox. Example: `"For job applications"`. Optional
`autoMapping`	`boolean`	If `true`, mailbox is auto-mapped for assigned users. Example: `true`. Optional
`alias`	`string`	Alternate email alias for the mailbox. Example: `"recruitment@company.com"`

Expanded Object Type Definitions

`metadata` (Object)

Stores additional information about the mailbox in key-value format.

Property	Type	Description & Example
Custom Key	`string`	Any key-value pair that provides extra details. Example: `{ "manager": "John Doe", "createdBy": "Admin" }`

Example Usage

{
  "metadata": {
    "el-text-388": "Used for customer inquiries",
    "manager": "John Doe",
    "createdBy": "Admin"
  }
}

`permissions` (Object)

Defines access rights for users to the mailbox.

Property (UUID)	Type	Description
User ID	`string`	Unique identifier of a user Example: a5f1b3d7-49c2-4e87-b4f6-d8e2a9c3e7b1
Access Level	`string` (enum)	One of: `"None"`, `"SendAs"`, `"FullAccess"`

Example Usage

{
  "permissions": {
    "49cf935a-284f-4c84-8df7-a5b11f1be527": "FullAccess",
    "f3c98a7b-129d-4f06-b8f1-e7a1d9c84e5a": "SendAs",
    "a5f1b3d7-49c2-4e87-b4f6-d8e2a9c3e7b1": "None"
  }
}

`roomMailboxMetadata` (Object)

Specific settings for room mailboxes (e.g., meeting rooms).

Property	Type	Description
`hasConferencePhone`	`boolean`	If `true`, the room has a conference phone.
`hasWhiteboard`	`boolean`	If `true`, the room has a whiteboard.
`hasVideoConferencing`	`boolean`	If `true`, the room has video conferencing equipment.

Example Usage

{
  "roomMailboxMetadata": {
    "hasConferencePhone": true,
    "hasWhiteboard": true,
    "hasVideoConferencing": false
  }
}

Example: Creating a Mailbox

POST https://api.easylife365.cloud/mail/v1/mailboxes/
Content-Type: application/json
Authorization: Bearer <token>

{
  "name": "john.doe",
  "displayName": "John Doe",
  "templateId": "fc6ffbd8-f7f0-4c05-b707-227d233b9e1b",
  "metadata": {
    "el-text-388": "Custom text field content goes here!"
  },
  "primaryOwner": "49cf935a-284f-4c84-8df7-a5b11f1be527",
  "secondaryOwner": "6a95c23b-cbb3-4f06-9b05-5e96ac65c78c"
}

Example: Creating a Shared Mailbox with dedicated permissions

HTTP Request

POST https://api.easylife365.cloud/mail/v1/mailboxes/
Content-Type: application/json
Authorization: Bearer <token>

Request Body

{
  "name": "support",
  "displayName": "Customer Support",
  "templateId": "fc6ffbd8-f7f0-4c05-b707-227d233b9e1b",
  "metadata": {
    "el-text-388": "Used for customer inquiries",
    "department": "Support"
  },
  "primaryOwner": "49cf935a-284f-4c84-8df7-a5b11f1be527",
  "secondaryOwner": "6a95c23b-cbb3-4f06-9b05-5e96ac65c78c",
  "permissions": {
    "a9b7d6f3-c2e5-4a1b-b9e7-f1d5a3e9c6d4": "FullAccess",
    "49cf935a-284f-4c84-8df7-a5b11f1be527": "SendAs"
  },
  "alias": "support@company.com",
  "autoMapping": true,
  "hideFromGAL": false,
  "notes": "Handles all customer support queries."
}

Example: Creating an Equipment Mailbox

HTTP Request

POST https://api.easylife365.cloud/mail/v1/mailboxes/
Content-Type: application/json
Authorization: Bearer <token>

Request Body

{
  "name": "projector-1",
  "displayName": "Conference Room Projector",
  "metadata": {
    "equipmentType": "Projector",
    "el-text-388": "4K projector for executive conference rooms."
  },
  "primaryOwner": "35c2f1d5-789e-4c53-ade4-f1c7e65a3e9f",
  "capacity": 500,
  "permissions": {
    "a9b7d6f3-c2e5-4a1b-b9e7-f1d5a3e9c6d4": "FullAccess",
    "49cf935a-284f-4c84-8df7-a5b11f1be527": "None"
  },
  "automaticReply": "This projector is available for booking via the calendar system.",
  "isAllowAutomaticReplyOverride": false,
  "notes": "Only authorized users can book this projector."
}

Example: Creating a Room Mailbox

HTTP Request

POST https://api.easylife365.cloud/mail/v1/mailboxes/
Content-Type: application/json
Authorization: Bearer <token>

Request Body

{
  "name": "executive-boardroom",
  "displayName": "Executive Boardroom",
  "officeLocation": "HQ - Floor 5",
  "streetAddress": "123 Corporate Blvd",
  "city": "New York",
  "country": "USA",
  "capacity": 20,
  "isWheelChairAccessible": true,
  "primaryOwner": "49cf935a-284f-4c84-8df7-a5b11f1be527",
  "permissions": {
     "a9b7d6f3-c2e5-4a1b-b9e7-f1d5a3e9c6d4": "FullAccess", 
    "49cf935a-284f-4c84-8df7-a5b11f1be527": "SendAs"
  },
  "roomMailboxMetadata": {
    "hasConferencePhone": true,
    "hasWhiteboard": true,
    "hasVideoConferencing": true
  },
  "automaticReply": "This room is available for booking during business hours.",
  "isAllowAutomaticReplyOverride": true
}

Example: Create shared mailbox with additional metadata

HTTP Request

POST https://api.easylife365.cloud/mail/v1/mailboxes/
Content-Type: application/json
Authorization: Bearer <token>

Request Body

{
  "name": "hr-recruitment",
  "displayName": "HR Recruitment",
  "metadata": {
    "department": "HR",
    "el-text-388": "Used for handling job applications."
  },
  "primaryOwner": "a9b7d6f3-c2e5-4a1b-b9e7-f1d5a3e9c6d4",
  "businessPhones": ["+1-800-555-1234"],
  "phone": "+1-800-555-5678",
  "permissions": {
    "a9b7d6f3-c2e5-4a1b-b9e7-f1d5a3e9c6d4": "FullAccess",
    "49cf935a-284f-4c84-8df7-a5b11f1be527": "SendAs"
  },
  "alias": "recruitment@company.com",
  "autoMapping": true,
  "hideFromGAL": false,
  "notes": "Receives resumes and job inquiries."
}

Comparison of Key Properties by Mailbox Type

Property	Shared Mailbox	Equipment Mailbox	Room Mailbox
`autoMapping`	✅ Yes	❌ No	❌ No
`alias`	✅ Yes	❌ No	❌ No
`capacity`	✅ Yes	✅ Yes	✅ Yes
`automaticReply`	✅ Yes	✅ Yes	✅ Yes
`permissions`	✅ Yes	✅ Yes	✅ Yes
`roomMailboxMetadata`	❌ No	❌ No	✅ Yes
`isWheelChairAccessible`	❌ No	❌ No	✅ Yes
`officeLocation`	❌ No	❌ No	✅ Yes
`equipmentType` (custom metadata)	❌ No	✅ Yes	❌ No

HTTP Request​

HTTP Request Headers​

Request Body​

Mailbox Properties Table​

Expanded Object Type Definitions​

metadata (Object)​

Example Usage​

permissions (Object)​

Example Usage​

roomMailboxMetadata (Object)​

Example Usage​

Example: Creating a Mailbox​

Example: Creating a Shared Mailbox with dedicated permissions​

HTTP Request​

Request Body​

Example: Creating an Equipment Mailbox​

HTTP Request​

Request Body​

Example: Creating a Room Mailbox​

HTTP Request​

Request Body​

Example: Create shared mailbox with additional metadata​

HTTP Request​

Request Body​

Comparison of Key Properties by Mailbox Type​

HTTP Request

HTTP Request Headers

Request Body

Mailbox Properties Table

Expanded Object Type Definitions

`metadata` (Object)

Example Usage

`permissions` (Object)

Example Usage

`roomMailboxMetadata` (Object)

Example Usage

Example: Creating a Mailbox

Example: Creating a Shared Mailbox with dedicated permissions

HTTP Request

Request Body

Example: Creating an Equipment Mailbox

HTTP Request

Request Body

Example: Creating a Room Mailbox

HTTP Request

Request Body

Example: Create shared mailbox with additional metadata

HTTP Request

Request Body

Comparison of Key Properties by Mailbox Type