Mailboxes

Order new mailboxes

Orders exactly what a quote showed. confirmed: true states that the person who pays said yes to the full quote. When the workspace allows purchases with its saved card, the card is charged within its limits; otherwise you get checkout_url, a payment page the person pays themselves. Nothing is bought before that payment. senders are the people the mailboxes send as.

CostWhat it doesKey scopes
The quoted price, charged only after the person who pays confirmedCharges moneyargorant:manage_lists
post/api/v1/inboxes/orders

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/inboxes/orders
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Request body

quote_idstring uuid required

The quote the person said yes to.

websitestring

Where visitors of the new domains go.

confirmedboolean required

true: the person who pays said yes.

pay_with'auto' | 'link'

auto or link.

Response

Created

order_idstring
checkout_urlstring
statusstring
existingboolean
messagestring

Changes

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