Skip to content

API: Setup

← API overview

GET /v1/orders/{order_id}/setup · scope: read · MCP tool: get_order_setup

The setup checklist of a paid order: what is saved and what is still missing.

Building starts only when setup is complete. checklist lists each step with done true/false; missing names the exact fields still needed. Logins are never returned, only whether they are on file.

ParameterInTypeRequiredNotes
order_idpathstringyesorder_id from get_checkout, list_orders or get_account_status
Terminal window
curl -X GET "https://api.maildeck.co/v1/orders/<order_id>/setup" \
-H "Authorization: Bearer $MAILDECK_API_KEY"

PUT /v1/orders/{order_id}/setup · scope: write · MCP tool: update_order_setup

Save part of an order’s setup: domains, registrar and sequencer access, business details.

Send only the parts you have; anything left out is kept. domains replaces the whole list. The registrar login must have two-factor switched off (two_factor_disabled: true) or our team cannot get in. Returns the updated checklist. When can_complete is true, call complete_order_setup.

ParameterInTypeRequiredNotes
order_idpathstringyesorder_id from get_checkout, list_orders or get_account_status
Body fieldTypeRequiredNotes
domainsarray of stringnoThe sending domains for this order, already bought at a registrar. Replaces the saved list
registrarobjectnoWhere the domains are registered, with access so DNS can be set
sequencerobjectnoThe sending tool the inboxes are uploaded to
contactobjectnoBusiness details for the invoice. The billing country was fixed at payment
mailbox_preferenceobjectnoA preference for inbox names. It is a request to our team, not a guarantee
mailboxesarray of objectnoBundles only: which domain goes on which platform
idempotency_keystringyesAny unique string for this action. Sending the same one again returns the first result instead of repeating the action. up to 200 chars
Terminal window
curl -X PUT "https://api.maildeck.co/v1/orders/<order_id>/setup" \
-H "Authorization: Bearer $MAILDECK_API_KEY" \
-H "Content-Type: application/json" \
-d '{"idempotency_key":"a-unique-string"}'

POST /v1/orders/{order_id}/setup/complete · scope: write · MCP tool: complete_order_setup

Finish setup so Maildeck starts building the inboxes. Cannot be undone through the API.

Locks the setup and hands the order to fulfilment. Fails with the list of missing fields if anything is still open. After this, changes go through support. Follow progress with get_order.

ParameterInTypeRequiredNotes
order_idpathstringyesorder_id from get_checkout, list_orders or get_account_status
Body fieldTypeRequiredNotes
idempotency_keystringyesAny unique string for this action. Sending the same one again returns the first result instead of repeating the action. up to 200 chars
confirmbooleanyesMust be true. Confirms the person has agreed to this action
Terminal window
curl -X POST "https://api.maildeck.co/v1/orders/<order_id>/setup/complete" \
-H "Authorization: Bearer $MAILDECK_API_KEY" \
-H "Content-Type: application/json" \
-d '{"idempotency_key":"a-unique-string","confirm":true}'