Sign in
Mailbox management

Add a mailbox

Creates a new mailbox in the mail hosting.

post/1/mail_hostings/{mail_hosting_id}/mailboxes

Path parameters

mail_hosting_idinteger required

The unique identifier (ID) of the mail hosting to request.

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

Request body

link_to_current_userboolean
mailbox_namestring required
notestring
random_delivery_hostboolean nullable
signature_model_idstring nullable
target'current_user' | 'ksuite_user' | 'other_user'

Specifies who has access to the mailbox during its creation.<note><strong>current_user</strong>: Only the current user has access to the mailbox.</note><note><strong>ksuite_user</strong>: All users who are part of the kSuite product can access the mailbox.</note><note><strong>other_user</strong>: All invited users can have access to the mailbox.</note>

Example request

{
  "target": "current_user"
}

Response

Created

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

Example response

{
  "result": "success"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.