mailbox_pack_create · Create Mailboxes

Queue mailbox provisioning for an approved or registrar-visible root domain using the customer order idempotency model.

Back to docs Open portal

Use this when

Best-fit situations

Create a mailbox order after registrar and EmailBison connections are ready.

Use generated naming patterns for a bounded mailbox pack.

Submit a customer-provided mailbox list without exposing raw secrets in status output.

Arguments

Expected inputs

approved_root_domain · required

One approved or registrar-visible root domain for this customer.

mailbox_count · required

Number of mailboxes to create. Must be between 1 and 100.

naming_pattern · optional

Supported generated naming pattern when mailbox_generation is omitted.

mailbox_generation · optional

Optional structured generated-name or custom mailbox-list payload.

idempotency_key · optional

Optional caller-controlled key for safe retries of the same order intent.

Success shape

What comes back

approved_root_domain

mailbox_count

preview_id

order_id

job_id

status

reused

Failure modes

What to expect when it blocks

mailbox_pack_create_failed when the mailbox request is invalid

quota_exceeded when the rolling order allowance is exhausted

setup_not_ready when customer setup prerequisites are incomplete

Example

Sample tool arguments

{
  "approved_root_domain": "mailionaire-demo.ch",
  "mailbox_count": 10,
  "naming_pattern": "first.last",
  "idempotency_key": "pilot-mailbox-order-001"
}