Mailspace
Mailspace is mailboxhosting op workspace-niveau: je schaft het aan voor een domein en het levert de mailboxen, aliassen en groepen voor dat domein. Deze endpoints gaan over de mailomgeving zelf — aanschaffen, bekijken, resizen, verwijderen en definitief verwijderen.
Alles binnen een mailomgeving heeft zijn eigen referentiepagina:
- Mailspace-mailboxen — mailboxen, app-wachtwoorden, mailregels, afwezigheidsberichten, doorsturen
- Mailspace-adressen — aliassen, groepen, mailinglijsten, anonieme e-mailadressen
- Mailspace-domeinen — extra domeinen, hun DNS-records en domeinverificatie
- Mailspace-logs en herstel — bezorglogs, archief van verwijderde mail, mailboxherstel
OAuth-scopes: reads vereisen mailspace:read, writes vereisen
mailspace:write. Sessie- en API-sleutel-credentials slaan de scopecontroles
volledig over (zie OAuth).
Mailspace-ID's zijn GUID's. Een mailomgeving die niet zichtbaar is voor je
credential geeft 404 terug; een credential zonder bewerkrecht op het
eigenaarsaccount geeft 403 {"errors":["Not Authorized"]} terug. Aanschaffen
en resizen belasten ook het facturatieaccount, dus daarvoor is bovendien
facturatierecht nodig op de workspace die wordt gefactureerd (403
not_authorized).
Mailspace wordt alleen op jaarbasis verkocht, dus geen enkel endpoint op deze
pagina accepteert een term-parameter.
Een 202 Accepted betekent niet dat de belasting is geslaagd
POST /api/mailspace en PATCH /api/mailspace/:id zijn asynchroon: ze bouwen een
cart, belasten het facturatieaccount off-session, en geven 202 terug met de
gedeelde cart-envelop.
Een geweigerde off-session-belasting is ook een 202. De envelop meldt dan
payment.status als "awaiting_authentication" en bevat een
payment.hosted_invoice_url waarmee de klant kan betalen (dit dekt ook 3DS/SCA).
Vertak op payment.status, nooit alleen op de HTTP-status.
Op een facturatieplan dat een opgeslagen kaart belast, wordt de cart asynchroon
afgewikkeld zoals hierboven beschreven en is een opgeslagen standaard betaalmethode
vereist (400 no_default_payment_method). Op een plan dat extern wordt
gefactureerd (betaalmethode "none") wordt er niets belast en wordt die controle
overgeslagen; het antwoord is nog steeds dezelfde 202-envelop. Lees payment (en,
bij een nabetaalde bestelling, billing) in het antwoord om te zien welk pad gold.
Zie Orders en
planwijzigingen van sites.
Leesfouten
Lijsten binnen een mailomgeving lezen live van de mailserver. Als een read niet kan
worden uitgevoerd, geeft het endpoint 503 terug met een code die de mislukte
read noemt, nooit 200 met een lege payload. Deze fouten zijn tijdelijk: probeer
opnieuw.
| Endpoint | Code |
|---|---|
GET /api/mailspace/:mailspace_id/mailboxes |
mailboxes_unavailable |
GET /api/mailspace/:mailspace_id/domains |
domains_unavailable |
GET /api/mailspace/:mailspace_id/aliases |
aliases_unavailable |
GET /api/mailspace/:mailspace_id/groups |
groups_unavailable |
GET /api/mailspace/:mailspace_id/mailing_lists |
mailing_lists_unavailable |
GET /api/mailspace/:mailspace_id/archived_items |
archived_items_unavailable |
GET /api/mailspace/:mailspace_id/purged_mailboxes |
purged_mailboxes_unavailable |
Regels die voor de Mailspace-endpoints gelden:
- Een
200-lijst betekent dat de read is uitgevoerd, niet dat de lijst compleet is. Principal-lijsten (mailboxen, groepen enzovoort) zijn beperkt tot 500 rijen en anonieme e-mailadressen tot 2000, zonder totaal en zonder vlag. De 500 wordt gedeeld door mailboxen en groepen, dus een mailomgeving met 500 of meer mailboxen kan nul groepen teruggeven. - Verwijder nooit je eigen records omdat een antwoord ze weglaat. Dit geldt het
meest voor
purged_mailboxes: een vermeld snapshot is echt, maar een lege lijst betekent alleen "niets gevonden", niet "de mail is weg". - Sommige reads geven
200met een lege of gedeeltelijke payload als de mailserver niet bereikbaar is: bezorglogs, mailboxdetails (groeps- en lijstlidmaatschappen, app-wachtwoorden, TOTP-vlag),GET .../app_passwordsenGET .../masked_emails.GET .../groups/:stalwart_idenGET .../mailing_lists/:stalwart_idgeven daarentegen404, dus één404daar bewijst niet dat de groep of lijst weg is; controleer de index. - Archief van verwijderde mail:
GET .../archived_itemsgeeft200met een lege lijst als de archieffunctie niet beschikbaar is, dus "niets gearchiveerd" en "niet beschikbaar" zien er hetzelfde uit. - Groepen hebben twee codes.
groups_unavailablebetekent dat de groepenlijst niet kon worden gelezen.group_members_unavailablebetekent dat de groepen wel terugkwamen maar de ledenaantallen niet. Die code komt ook voor bijGET .../groups/:stalwart_id, en bijPATCH .../groups/:stalwart_id, waar de wijziging al is toegepast: lees de groep opnieuw in plaats van de wijziging opnieuw te sturen. stalwart_unavailable(503) betekent dat mailhosting niet is geconfigureerd op het platform, of dat één afzonderlijke read mislukte (bijvoorbeeld het opzoeken van het domein bij/api/mailspace/:mailspace_id/domains/:name; zie Mailspace-domeinen). Opnieuw proberen kan. Een onbekend of buiten bereik vallend:mailspace_idgeeft altijd404met een lege body.- Twee endpoints gebruiken een andere status: de mailregel- en
afwezigheidsendpoints geven
422mail_rules_unavailableals het filterscript van een mailbox niet kan worden teruggelezen (zie Mailspace-mailboxen), en het downloaden van een gearchiveerd bericht geeftdownload_unavailablemet404als het bericht weg is (stop) of503bij elke andere leesfout (probeer opnieuw). Zie Mailspace-logs en herstel.
Writes die 503 teruggeven
Controleer bij een write de code: sommige betekenen dat er niets is geprobeerd, andere dat de uitkomst onbekend is.
Er is niets geprobeerd. Probeer opnieuw:
PATCH .../purged_mailboxes/:guid→restore_unavailablePOST,DELETE,GETen de download op.../archived_items/:stalwart_id→archived_item_lookup_unavailable
De uitkomst is onbekend. Lees opnieuw in voordat je het opnieuw probeert:
POST .../archived_items/:stalwart_id/restore→restore_unconfirmed. Het herstel staat mogelijk al in de wachtrij.DELETE .../archived_items/:stalwart_id→delete_unconfirmed. Het wissen kan al zijn gebeurd en is onomkeerbaar. Lees het item terug; een404betekent dat het is gelukt.POST .../aliasesenDELETE .../aliases/:address→aliases_unavailable. De alias is mogelijk aangemaakt of verwijderd. LeesGET .../aliasesopnieuw in; beide writes opnieuw uitvoeren is veilig.DELETE .../mailboxes/:id/force_delete→delete_unavailable. De mailbox is al weg van de mailserver, maar of de mail herstelbaar is, is niet bevestigd. De mailbox staat nog in de lijst en de opruiming probeert opnieuw.
Een 422 betekent dat de mailserver antwoordde en weigerde. Bij het herstel van
een verwijderde mailbox betekent 409 not_recoverable dat er niets meer te doen is,
422 restore_failed dat opnieuw proberen kan werken, en 503 restore_unavailable
dat de controle niet kon worden uitgevoerd.
Mailomgevingen opvragen
GET /api/mailspace
Geeft de mailomgevingen terug, nieuwste eerst. Met soft delete verwijderde mailomgevingen (die op verwijderen wachten) zijn inbegrepen — ze blijven vermeld gedurende hun bewaartermijn; definitief verwijderde records zijn weg. Dit endpoint is niet gepagineerd.
Met de header X-Auth-Account is de lijst die van dat account; zonder die header valt
een credential zonder account terug op elke mailomgeving die de gebruiker van het
token kan bereiken.
Teruggegeven params
- mailspaces: Array
- id: String | GUID
- domain: String | het maildomein, bijv.
example.com - account_name: String | de mailaccountnaam die op het record staat
- package: String | mail-Product short_name, bijv.
mail_5 - package_name: String | weergavenaam, bijv.
Mailspace 5GB - status: String |
pending,active,suspended, ofinactive - storage_gb: Integer | opslag die bij het pakket hoort
- max_mailboxes: Integer | mailboxlimiet van het pakket
- used_mb: Integer | laatst gemeten opslaggebruik, in MB
- mailbox_count: Integer | momenteel gedefinieerde mailboxen
- provisioned: Boolean | de mailtenant bestaat en is klaar voor gebruik
- verified: Boolean | domeineigendom is bevestigd
- needs_domain_verification: Boolean | er moet nog een DNS-TXT-record worden gepubliceerd — zie Een mailomgeving bekijken
- pending_deletion: Boolean | met soft delete verwijderd; alleen herstellen of definitief verwijderen
- delete_scheduled_at: DateTime | vastgelegde datum van definitieve verwijdering,
nullzolang de mailomgeving actief is - created_at: DateTime
- updated_at: DateTime
- account: Object
- id: String
- name: String
Een mailomgeving bekijken
GET /api/mailspace/:id
Geserialiseerd uit de lokale status — geen live aanroep naar de mailserver, dus
used_mb en mailbox_count zijn de laatst gemeten waarden, geen live cijfers.
synced_at is geen tijdstempel voor de gebruikscijfers
synced_at wordt gezet wanneer iemand de mailomgeving in het dashboard
opent — en wordt ook gezet als het uitlezen van het gebruik op die pagina is
mislukt. used_mb en mailbox_count hebben intern hun eigen meetmoment, dat
deze API niet blootgeeft. Een workspace die uitsluitend de API gebruikt, kan
dus synced_at: null zien naast volledig actuele gebruikscijfers (een resize
meet het gebruik opnieuw zonder synced_at aan te raken), of een synced_at
die nieuwer is dan de cijfers ernaast. Beschouw de twee als los van elkaar.
Teruggegeven params
- mailspace: Object
- alle velden uit Mailomgevingen opvragen, plus:
- synced_at: DateTime | wanneer de mailomgeving voor het laatst in het dashboard is geopend,
nullals dat nooit is gebeurd. Geen tijdstempel voorused_mb/mailbox_count— zie hierboven - webmail_url: String | toegangspunt voor webmail voor het domein
- webmail_ready: Boolean | of
webmail_urlal werkt (er is een actief DNS-record en een certificaat voor nodig). Vertak hierop, niet op de aanwezigheid van de URL - verification: Object | alleen aanwezig zolang
needs_domain_verificationwaar is- txt_prefix: String |
_mailspace-verify - txt_host: String | de recordhost, bijv.
_mailspace-verify.example.com - txt_value: String | het token dat je als TXT-waarde publiceert
- txt_prefix: String |
- subscription: Object | alleen aanwezig wanneer er een facturatieabonnement is gekoppeld
- id: String
- status: String
- created_at: DateTime
- updated_at: DateTime
- price: Object
- amount_cents: Integer
- term: String
- account: Object
- id: String
- name: String
Het verification-blok is de to-do na aanschaf
Voor een domein dat de workspace nog niet in eigendom heeft, wordt de mailomgeving
na afwikkeling van de betaling aangemaakt met de status Wacht op verificatie.
Poll dit endpoint, publiceer het TXT-record uit het verification-blok, en de
mailomgeving wordt bij de volgende controleronde zelf voorzien. Het blok hangt af
van needs_domain_verification en verdwijnt dus zodra het eigendom is
vastgesteld — nog vóór provisioned op true staat. Zie het verdwijnen van het
blok niet als "de mailomgeving is klaar"; controleer provisioned. Voor een domein
dat de workspace al in eigendom heeft, wordt verificatie overgeslagen en verschijnt
het blok helemaal niet.
Een mailomgeving aanschaffen
POST /api/mailspace
Bouwt een losstaande cart voor de mailomgeving en verstuurt die. Geeft
202 Accepted terug met de cart-envelop — lees de waarschuwing bovenaan deze
pagina opnieuw voordat je de reactie verwerkt.
Een accountcontext is vereist, omdat de aanschaf moet weten wat er gefactureerd
wordt: geef de header X-Auth-Account mee of gebruik een credential met accountscope.
De mailomgeving zelf bestaat nog niet wanneer de 202 wordt teruggegeven — die wordt
pas aangemaakt nadat de betaling is afgewikkeld, dus staat er geen mailspace-ID in de
reactie. Poll cart.poll_url totdat de cart klaar is, en zoek de nieuwe mailomgeving
vervolgens op met GET /api/mailspace.
Params
- domain: String (required) | het maildomein; wordt voor je omgezet naar kleine letters en getrimd. Moet op een echte hostname lijken en moet een domein zijn dat daadwerkelijk bestaat (bij ons of elders geregistreerd).
- package: String (optional) | mail-Product short_name —
mail_5,mail_20,mail_50,mail_200,mail_500. Standaard het basispakket (de kleinste tier).
curl -X POST \
-H "Authorization: Bearer $CLOUDPRESS_TOKEN" \
-H "X-Auth-Account: $ACCOUNT_ID" \
-H "Content-Type: application/json" \
-d '{"domain": "example.com", "package": "mail_50"}' \
https://my.cloudpress.com/api/mailspace
Teruggegeven params (altijd 202 Accepted)
De gedeelde cart-envelop, identiek aan POST /api/orders:
- status: String |
"accepted" - cart: Object |
{ token, status, rollup_status, poll_url } - payment: Object |
{ status, method_type, hosted_invoice_url } - orders: Array |
[{ id, status, poll_url }](leeg tijdens het asynchrone venster)
Fouten
- 503
stalwart_unavailable| mailhosting is momenteel niet beschikbaar - 400
account_required| geen accountcontext — geefX-Auth-Accountmee of gebruik een credential met accountscope - 400
invalid_domain|domainontbreekt of is geen plausibele hostname - 400
unknown_product|packageis geen van de mailpakketten - 422
domain_not_registered| het domein is nergens geregistreerd, dus mail ervoor zou nooit kunnen werken. Wordt naunknown_productgecontroleerd, dus een verzoek dat op beide punten fout is, antwoordt nog steedsunknown_product. - 422
mailspace_exists| het domein heeft al een mailomgeving. Dat geldt ook voor je eigen mailomgeving die op verwijderen wacht — het domein blijft de hele bewaartermijn geclaimd, dus herstel die in plaats van opnieuw aan te schaffen. - 400
no_default_payment_method| alleen bij Stripe-facturatieplannen: het facturatieaccount heeft geen Stripe-customer, geen opgeslagen standaard betaalmethode, of een onvolledig facturatiecontact. De body bevat naasterrorsencodeook eenremediation-string. - 403
not_authorized| de gebruiker mag geen facturatie beheren op de workspace die wordt gefactureerd - 422
cart_item_rejected| de cart weigerde het mail-item — meestal omdat de mailprijzen voor het gevraagde pakket nog niet zijn geconfigureerd - 422
cart_pay_failed| de cart was geldig maar de belasting kon niet worden gestart (een weigering die wel is gestart, is een202en niet dit)
Weigeringen van de afrekenroutes: 400 billing_details_incomplete; 403 billing_permission_required; 409 bank_transfer_in_progress, bank_transfer_busy, postpay_busy; 422 outstanding_balance_exceeded, in_flight_limit_exceeded, payer_in_dunning, recent_dispute, instant_payment_method_required, bank_transfer_refused, bank_transfer_failed, postpay_route_changed, postpay_pay_open_invoices, postpay_contact_support, postpay_payment_in_progress, postpay_failed. Zie Orders
Er is geen WordPress-site nodig
De regel binnen de cart dat mail alleen bovenop WordPress- of cPanel-hosting kan worden toegevoegd, geldt hier niet: dit endpoint bouwt een eigen cart voor de mailomgeving, die per constructie aan die regel voldoet. Een mailomgeving kan via de API los worden aangeschaft, voor elk bestaand domein.
Een mailomgeving resizen
PATCH /api/mailspace/:id
Zet de mailomgeving over naar een ander pakket. Net als de aanschaf is dit
cart-gemedieerd en asynchroon — 202 Accepted met dezelfde envelop, en hetzelfde
voorbehoud rond payment.status.
Op een Stripe-facturatieplan wordt de wijziging naar rato verrekend met het bestaande abonnement van de mailomgeving. Op een extern gefactureerd plan is er geen Stripe-belasting; het nieuwe pakket wordt toegepast en buiten het platform gefactureerd.
Het huidige opslaggebruik wordt bij elke resize opnieuw gemeten tegen de mailserver — ook bij upgrades, ook al kan alleen een downgrade erdoor worden geblokkeerd — dus een resize-verzoek is niet direct klaar, zelfs niet vóór de belasting.
Params
- package: String (required) | de mail-Product short_name van het doelpakket. Moet verschillen van het huidige pakket.
Teruggegeven params (altijd 202 Accepted)
De gedeelde cart-envelop — zie Een mailomgeving aanschaffen.
Fouten
Worden in deze volgorde geëvalueerd:
- 503
stalwart_unavailable| mailhosting is momenteel niet beschikbaar - 403
not_authorized| geen bewerkrecht op de workspace die eigenaar is (geencode-veld), of geen facturatierecht op de workspace die wordt gefactureerd (codeisnot_authorized) - 503
mailspace_server_mismatch| de mailomgeving hoort bij een andere mailserver dan de server die nu is geconfigureerd; er wordt niets gelezen of geschreven. Neem contact op met support - 403
mailspace_suspended| de mailomgeving is geblokkeerd (door support of wegens een onbetaalde factuur) en kan niet worden gewijzigd - 422
pending_delete| de mailomgeving staat gepland voor verwijdering — herstel die eerst - 400
unknown_product|packageis geen van de mailpakketten - 422
package_unchanged| zit al op dat pakket - 422
not_provisioned| de mailomgeving is nog niet klaar met inrichten - 422
resize_unavailable| alleen bij Stripe-facturatieplannen: de mailomgeving heeft geen actief facturatieabonnement om naar rato tegen te verrekenen - 422
downgrade_blocked| het doelpakket is kleiner dan het huidige aantal mailboxen of de opgeslagen mail van de mailomgeving. Verwijder eerst mailboxen of maak opslag vrij. - 400
no_default_payment_method| alleen bij Stripe-facturatieplannen, zoals bij aanschaf - 422
cart_item_rejected| de cart kon de wijziging niet opbouwen - 422
cart_pay_failed| de naar rato verrekende belasting kon niet worden gestart
De weigeringen van de afrekenroutes die onder
Een mailomgeving aanschaffen staan, gelden
hier ook, plus 422 postpay_change_refused.
Een mailomgeving verwijderen
DELETE /api/mailspace/:id
Wat dit doet, hangt ervan af of de mailomgeving ooit is voorzien — de twee
uitkomsten verschillen wezenlijk, en het endpoint biedt geen manier om er een van te
kiezen. Beide geven 200 terug met een lege body, dus controleer provisioned
op de mailomgeving voordat je dit aanroept als het verschil uitmaakt.
Soft delete. De mailomgeving stopt met het verwerken van mail en gaat een
bewaartermijn in; pending_deletion wordt true en delete_scheduled_at is
de vastgelegde datum van definitieve verwijdering. De mailomgeving blijft
zichtbaar in GET /api/mailspace. De facturatie wordt beëindigd met een naar
rato verrekend tegoed voor de vroegtijdige opzegging. Eerder definitief
verwijderen dan de bewaartermijn toestaat, kan met
Een mailomgeving definitief verwijderen
hieronder; herstellen hoort niet bij deze API — gebruik daarvoor het
dashboard.
Idempotent: een mailomgeving verwijderen die al op verwijderen wacht, lukt en verandert niets.
Harde verwijdering, en de volledige eerste termijn wordt teruggegeven. Een
mailomgeving die nog op domeinverificatie wacht, heeft geen mailtenant om te
blokkeren en heeft niets van haar vooruitbetaalde termijn gebruikt, dus wordt
de aanschaf hiermee volledig teruggedraaid: het record wordt vernietigd
(het verdwijnt uit GET /api/mailspace; pending_deletion wordt nooit gezet
en delete_scheduled_at wordt nooit toegekend), de oorspronkelijke bestelling
wordt volledig terugbetaald en gemarkeerd als cancelled, en de
abonnementsregel wordt verwijderd.
Omdat het record weg is, komt het domein direct vrij — een nieuwe aanschaf
voor hetzelfde domein slaagt in plaats van te stuiten op mailspace_exists.
Draait in beide gevallen synchroon.
curl -X DELETE \
-H "Authorization: Bearer $CLOUDPRESS_TOKEN" \
-H "X-Auth-Account: $ACCOUNT_ID" \
https://my.cloudpress.com/api/mailspace/$MAILSPACE_ID
Een met soft delete verwijderde mailomgeving houdt zijn domein geclaimd
Een voorziene mailomgeving houdt zijn maildomein de hele bewaartermijn. Een
nieuwe mailomgeving aanschaffen voor dat domein mislukt in de tussentijd met
422 mailspace_exists — herstel in plaats daarvan de bestaande. Dit geldt
niet voor het nooit-voorziene geval hierboven, waar het record wordt vernietigd
en het domein meteen vrijkomt.
Fouten
- 503
stalwart_unavailable| mailhosting is momenteel niet beschikbaar - 503
mailspace_server_mismatch| de mailomgeving hoort bij een andere mailserver dan de server die nu is geconfigureerd; er wordt niets gewijzigd. Neem contact op met support - 403
mailspace_suspended| de mailomgeving is geblokkeerd (door support of wegens een onbetaalde factuur) en kan niet worden verwijderd - 422
delete_failed| de verwijdering kon niet worden afgerond. Op het nooit-voorziene pad dekt dit ook een mislukte creditering — de terugbetaling kon niet worden verwerkt, dus wordt de mailomgeving bewust intact gelaten in plaats van onbetaald verwijderd. Probeer het opnieuw.
Een mailomgeving definitief verwijderen
POST /api/mailspace/:mailspace_id/purge
Vernietigt een mailomgeving die al met soft delete is verwijderd, in plaats van
de bewaartermijn af te wachten. Geeft 200 terug.
Onomkeerbaar, en de mail gaat mee
De tenant op de mailserver — elk domein, elke mailbox en alle opgeslagen berichten — en het lokale record worden vernietigd, en de mailrecords die CloudPress in de door ons gehoste DNS-zone van de klant heeft gezet, worden verwijderd. Niets hiervan is te herstellen, en er volgt geen taak: het werk is klaar op het moment dat je het antwoord krijgt.
Er is geen bevestigingsparameter. De enige voorwaarde is dat de mailomgeving al op verwijderen wacht.
De facturatie blijft ongemoeid — die is al beëindigd bij de soft delete, dus eerder definitief verwijderen levert geen terugbetaling en geen extra kosten op.
Elke definitieve verwijdering wordt met de gebruikte credential vastgelegd in het auditlog van het platform.
Teruggegeven params
- purged: Boolean | altijd
true; een verwijdering die niets opruimde geeft in plaats daarvan een409 - domain: String | het maildomein dat is vrijgekomen, vastgelegd voordat het record werd vernietigd
curl -X POST \
-H "Authorization: Bearer $CLOUDPRESS_TOKEN" \
-H "X-Auth-Account: $ACCOUNT_ID" \
https://my.cloudpress.com/api/mailspace/$MAILSPACE_ID/purge
Een actieve mailomgeving definitief verwijderen geeft een 409
409 not_pending_deletion betekent dat er niets is verwijderd en dat de
mailomgeving er nog is. Het dekt zowel een mailomgeving die nooit is verwijderd
— roep eerst DELETE /api/mailspace/:id aan — als de race waarin er tussen de
controle en de vernietiging een herstel plaatsvindt.
Fouten
- 404 | de mailomgeving is niet zichtbaar voor je credential
- 503
stalwart_unavailable| mailhosting is momenteel niet beschikbaar - 403
not_authorized| de credential heeft geen bewerkrecht op de eigenaars-workspace - 503
mailspace_server_mismatch| de mailomgeving hoort bij een andere mailserver dan de server die nu is geconfigureerd. Neem contact op met support - 403
mailspace_suspended| de mailomgeving is actief en geblokkeerd (door support of wegens een onbetaalde factuur) - 409
not_provisioned| de mailomgeving heeft geen tenant op de mailserver om te vernietigen - 409
not_pending_deletion| de mailomgeving is niet ingepland voor verwijdering — zie hierboven - 422
purge_failed| de definitieve verwijdering kon niet worden afgerond; er is niets vernietigd
Foutcodes
Alle fouten gebruiken de standaardenvelop {"errors": [...], "code": "..."} die is
beschreven in Foutreacties.
Dezelfde codenaam, een andere status, binnen een mailomgeving
De endpoints op deze pagina geven pending_delete en not_provisioned zelf
terug, als 422. De geneste endpoints — mailboxen, adressen, domeinen,
logs — erven ze van een gedeelde gate, die 403 teruggeeft voor
pending_delete en 409 voor not_provisioned. Een client die op de
status vertakt in plaats van op de code, leest een van de twee families
verkeerd.
De 403 voor bewerkrecht op deze pagina bevat bovendien helemaal geen
code-veld ({"errors":["Not Authorized"]}); de geneste gate geeft daar
not_authorized bij. De 403 voor facturatierecht bij aanschaf en resize
bevat wél not_authorized.
De geneste endpoints, reads inbegrepen, geven ook mailspace_server_mismatch
(503) terug.
| Code | Status | Geretourneerd door |
|---|---|---|
stalwart_unavailable |
503 | create, update, destroy, purge |
mailspace_server_mismatch |
503 | update, destroy, purge |
account_required |
400 | create |
invalid_domain |
400 | create |
domain_not_registered |
422 | create |
unknown_product |
400 | create, update |
mailspace_exists |
422 | create |
no_default_payment_method |
400 | create, update |
cart_item_rejected |
422 | create, update |
cart_pay_failed |
422 | create, update |
mailspace_suspended |
403 | update, destroy, purge |
pending_delete |
422 | update |
package_unchanged |
422 | update |
not_provisioned |
422 | update |
resize_unavailable |
422 | update |
downgrade_blocked |
422 | update |
delete_failed |
422 | destroy |
not_authorized |
403 | create, update (facturatierecht), purge |
billing_details_incomplete |
400 | create, update |
billing_permission_required |
403 | create, update |
bank_transfer_in_progress, bank_transfer_busy, postpay_busy |
409 | create, update |
outstanding_balance_exceeded, in_flight_limit_exceeded, payer_in_dunning, recent_dispute, instant_payment_method_required, bank_transfer_refused, bank_transfer_failed, postpay_route_changed, postpay_pay_open_invoices, postpay_contact_support, postpay_payment_in_progress, postpay_failed |
422 | create, update |
postpay_change_refused, postpay_add_payment_method |
422 | update |
not_provisioned |
409 | purge |
not_pending_deletion |
409 | purge |
purge_failed |
422 | purge |