Exchange will be rebuilt separately and is unavailable through the API or CLI. Availability in this release

API guide

For applications and automation. Create a separate integration with an explicit company, purpose, permissions and expiry date.

Code examples in four languages: Python, JavaScript / TypeScript, PHP, C#

Availability

The API is enabled on this environment. Your account capabilities and granted permissions determine which actions are available.

Every customer can use the API and CLI through the public preview. Company permissions, scopes and additional verification determine which actions a connection can perform. Read the preview conditions

Your company access and service data

Your connection is limited to the current company permissions and the scopes you approved. Internal registrar identities and object IDs are excluded from customer responses, including field selection and filters. Company ownership does not grant platform-administrator access. DNS integrations you choose yourself remain visible where needed to manage DNS.

managed_by_binadit: whether Binadit manages the domain registration, as shown in the portal.
invoice_number / invoice_id: the invoice number and the local invoice ID associated with an order.
billing_mode: managed: an existing managed billing agreement for a domain, without naming the underlying billing system.

Historical results follow the same public-field rules. You can only read an operation submitted through your own connection. Its result can be null when the current permissions do not allow the payload or the original action cannot be verified. A restricted connection also receives status without a historical payload. This is not permission to submit a replacement request.

Authentication

People connect with browser-based OAuth login. A verified passkey remains valid within the same valid portal session; signing out, session expiry or revocation ends that proof. Sensitive API operations retain their separate verification rules. Applications use a client ID and a secret generated for their integration, then request short-lived access tokens. Never share a personal password or a provider’s API key.

Choose New integration and enter a name that identifies the application.
Select permissions, optional resource restrictions, and an expiry date.
Confirm your identity and create the connection.
Save the displayed client ID and one-time secret in your application’s secret manager.

The secret is shown once. If you lose it, rotate the integration’s secret. Rotation replaces both the client ID and secret and invalidates the previous credentials and tokens; update both values in the application immediately.

API and integrations

Request an access token

Send a form-encoded POST to /oauth/token with grant_type=client_credentials, client_id, client_secret and the requested scope. The requested scope must be allowed on the integration. Use HTTPS and keep the secret out of URLs, shell history and logs.

The response contains access_token, token_type and expires_in. Send the token in the Authorization header. Obtain a new token when it expires; do not keep retrying invalid credentials.

The client pair expires after the selected period (30 days to 2 years) or never, until revoked. An optional IP allowlist is checked at token issuance and on every request (error code ip_not_allowed). An access token separately remains valid for up to 5 minutes. Only a company owner can create or change service connections.

Make a read request

This shell example reads the token from an environment variable and supplies the header through standard input. Disable shell tracing and do not print the variable.

Shell

set +x
printf 'header = "Authorization: Bearer %s"\n' "$BINADIT_ACCESS_TOKEN" |
  curl --config - --fail-with-body --silent --show-error \
  -H 'Accept: application/json' \
  'https://my.binadit.com/api/v1/accounts'

Company and resource selection

List your accessible companies, then use the intended account ID in every company-scoped request. Some credentials are limited to selected DNS zones or workspaces. A resource ID from another company is never a way to extend that access.

Read the account’s capabilities before automating a feature. A route in the reference does not guarantee that a supplier, product or write operation is enabled for your company.

Example — replace the company ID with your own

GET /api/v1/accounts/123/capabilities

Changes, costs and retries

Use the operation’s documented preflight or dry-run first where available. Confirm the target company, expected version, price and billing period before committing. Never repeat an order with a new idempotency key just because the first response was lost.

For supported create and order actions, send a unique Idempotency-Key and reuse that same key with the same input when retrying. Reusing it with different input returns a conflict. The operation reference identifies the required headers.

Before changing a resource, read it and copy its ETag into If-Match. The CLI displays this version as meta.etag. A missing version gives 428; a changed version gives 412. Read again and review the new data.

Example: update a company profile

Read /accounts/{account}/profile with account:read. PATCH on the same path requires account:write, Idempotency-Key and the current If-Match. Payment mandates and internal provider links are not profile fields.

JSON

{"contact_email":"administratie@example.nl","city":"Utrecht"}

Example: invite a colleague

POST /accounts/{account}/team/invitations requires team:write and a human session with strong verification no more than 5 minutes old. A service connection cannot grant access. You can only delegate your own current permissions; the response never contains an acceptance token.

JSON

{"email":"collega@example.nl","permissions":[{"module":"module_dns","level":"read"}]}

Example: create a registrar contact

POST /accounts/{account}/holders requires holders:write and Idempotency-Key. PUT /holders/{id} uses the same complete contact input plus If-Match; DELETE requires the current version and an unused contact. Company ownership and registrar handles are assigned by the server.

JSON

{
    "initials": "A",
    "firstname": "Ada",
    "lastname": "Example",
    "gender": "F",
    "street": "Teststraat",
    "number": "1",
    "zipcode": "1234 AB",
    "city": "Utrecht",
    "country": "NL",
    "email": "contact@example.nl"
}

Schedule DNS changes

Read /dns/zones/{zone}/scheduled-change for status and ETag. PUT on the same path schedules validated changes with execute_at: an ISO timestamp with timezone, up to 30 days ahead. Use If-Match and Idempotency-Key; dry-run executes nothing. DELETE cancels; the pause and resume actions pause or resume work.

JSON

{"execute_at":"2026-11-14T09:00:00+00:00","changes":[{"action":"create","name":"_verify","type":"TXT","value":"example"}]}

The API and portal share the same DNS records, history, scheduler and configured provider connection. The CLI communicates with the portal over HTTPS; direct nameserver access is not needed. Execution checks the connection, company permissions and resource restrictions again. An expired access token does not cancel approved work; an expired or revoked connection blocks it. A changed zone or failed provider action needs review and is not retried automatically. Resuming creates a newly approved request under the current connection.

Receive secrets once

Sensitive password or transfer-code actions require separate scopes and recent strong human verification. The initial action returns a credential_claim_id. The consume action returns the secret once and erases it; it does not use an idempotency key. Dry-run returns metadata only. Never automatically retry consumption after an ambiguous network failure. The CLI saves secrets to a new private file and refuses existing files.

Review an offer before ordering

POST /accounts/{account}/order-quotes receives kind and input. Read /order-quotes/{id}, then confirm with POST /orders and {"quote_id":"…"}. Product-specific scopes apply in addition to orders:write and orders:commit. Quotes expire and must be rechecked at confirmation. The response and operation distinguish payment, approval and actual delivery.

Prepare one product offer with orders quote, inspect its current prices and expiry, then confirm that quote separately with orders commit. Viewing or previewing an offer creates no paid order. A confirmed quote is one order intent; separate confirmations are separate orders and do not promise a combined invoice.

Follow long-running work

A 202 Accepted response means work has been accepted. Follow the operation ID until its status is final. Waiting for payment or approval is different from failure. Closing the CLI or losing a connection does not cancel server-side work.

Webhooks

Receive company-wide API status notifications at your own HTTPS address. This receiver gets status notifications from every API connection in this company. Messages contain only the operation ID, company ID, action and status. They do not grant access to private results from other connections.

A new webhook starts paused. Configure the signing key on your receiver first, then enable the webhook. Requires an active, unrestricted service connection in this company with webhooks:read and operations:read. Revoking or expiring that connection stops delivery.

Verify the HMAC signature over the unmodified body, accept timestamps within five minutes and process each event ID once. Return 2xx after the message has been stored durably. You receive operation.updated. A paused webhook sends nothing; pending messages remain available until their retry deadline of up to three days.

Binadit-Webhook-Id · Binadit-Webhook-Timestamp · Binadit-Webhook-Signature

HMAC-SHA256

HMAC-SHA256(signing_secret, timestamp + "." + delivery_uuid + "." + raw_body)
Binadit-Webhook-Signature: v1=<hex>,key_id=<key UUID>

Use the entire signing_secret as the UTF-8 key, including its whsec_ prefix. Do not base64-decode it. Compare the lowercase hexadecimal signature in constant time, check the key ID and enforce a 300-second time window. Retries use the same event ID in body.id; store it atomically with your processing job.

A company owner, or a team member with the Webhooks right (write), manages /webhooks with webhooks:write and recent strong verification. Creation and rotation also require webhooks.secret:read; the result is a credential_claim_id for one-time delivery within two minutes. Never automatically retry an actual consume request. The endpoint reference contains the full input contract.

Add a receiver

Errors and limits

Errors use application/problem+json with a stable code, a safe explanation and a request ID. Keep the request ID when asking for support; never send your secret or access token.

HTTP status	What to do
`401`	Your token is missing, invalid or expired. Reconnect or request a new token.
`403`	The requested action is not permitted or requires additional verification. Check scopes and company policy.
`404`	The resource was not found within your permitted company context.
`409 / 412`	The request conflicts with an existing intent or a newer resource version. Read the current state before retrying.
`422`	Correct the indicated input fields before sending the request again.
`429`	The rate limit has been reached. Respect Retry-After and reduce concurrency.
`5xx`	The service could not complete the request. Check operation status before repeating a change.

Keep connections secure

A public preview for every customer

The public preview is open to every authorized customer company; no pilot admission is required. Sensitive actions still require the relevant scopes, current company permissions, enabled features and recent strong human verification. Internal administration additionally requires an actual internal administrator with passkey verification. General availability with sender-constrained access tokens has not been released. Capabilities report sender_constraint_release_gate when an environment has not enabled an eligible preview release; the action may return 503 with that code. Ordinary portal actions keep their existing portal policy.

Use a separate integration per application and company.
Start with read permissions and restrict resources wherever possible.
Keep secrets in a credential store or secret manager, never in Git or config files.
Use API and integrations to inspect last use, rotate credentials and revoke access.
Treat password reveals, transfer codes and destructive actions as separate sensitive operations.

Workflow guides

Availability in this release

Filtering configuration and original-request recovery

Filtering orders and original delivery recovery

Administrative announcements and original mail acceptance

Import existing spam filters and review billing

Action log: safe global events

Historical payments: metadata and processing flags

Manage public portal settings

Inspect an original operation after reconnecting

Team invitations, permissions and safe delivery

Default margins and catalog pricing

Explicit portal mail tests

Service renewal and original-request recovery

Review registrar inventory and safely import registrations

Move domains between companies with reviewed billing periods (administrators)

Current permissions and recovery after uncertain billing

Review accounting contacts and explicitly link a company (administrators)

Create company contacts and recover the original request

Registrar contacts and original-request recovery

DNS changes and original-request recovery

Manage companies and users securely

Company resources and safe counts

Workspace administration for internal administrators

Shared mailboxes: portal, API and CLI

MailSig and mailbox profiles

Delegates, calendar access, mailing lists and rooms

Safely adopt existing Workspace mailboxes

Import existing Hosting with separate ownership and billing review

Manage Hosting packages and immutable Plesk plan revisions

Renewal estimates and invoices

Safely manage supplier servers

Endpoint reference

Download OpenAPI

The reference is generated from the implemented operation catalogue. An operation may still require account capabilities, additional verification or an enabled feature.

Filter endpoints by path, area or scope

558 Operation details

GET/api/v1/accounts/{account}/bank-details

Read company bank details as a recently verified owner

Operation ID: account.bank.get
Required scope: account.bank:read
Action type: Sensitive action requiring extra verification

PUT/api/v1/accounts/{account}/bank-details

Update an unbound IBAN without creating or changing a mandate

Operation ID: account.bank.update
Required scope: account.bank:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/profile

Read company profile and version

Operation ID: account.profile
Required scope: account:read
Action type: Read

PATCH/api/v1/accounts/{account}/profile

Update company profile

Operation ID: account.profile.update
Required scope: account:write
Action type: Change

PATCH/api/v1/accounts/{account}/security-policy

Update security policy as a recently verified company owner

Operation ID: account.security.update
Required scope: account:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/capabilities

Discover available operations for this company

Operation ID: accounts.capabilities
Required scope: account:read
Action type: Standard action

POST/api/v1/accounts/{account}/admin/announcements/{audience}/review

Review exact current company or human recipients and a plain-text administrative message

Operation ID: admin.announcements.review
Required scope: admin:read
Action type: Read

GET/api/v1/accounts/{account}/admin/announcements/{audience}/{announcement}

Inspect original administrative mail acceptance counts without private recipient addresses or message bodies

Operation ID: admin.announcements.get
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/announcements/{audience}

Queue one reviewed administrative announcement without automatically resending uncertain recipients

Operation ID: admin.announcements.send
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/billing/renewal-forecast

Inspect platform renewal estimates and unresolved company bindings after human passkey verification

Operation ID: admin.renewal-forecast.list
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/companies/actions/bulk

Apply one atomic reviewed local selection without deleting history or silently restoring access

Operation ID: admin.companies.bulk
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/companies/{company}/attachable-domains

Read bounded local domain candidates; every candidate still requires an explicit ownership review

Operation ID: admin.companies.attachable-domains.list
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/companies/{company}/resource-counts

Count the same verified company resources without reading credentials or legacy log details

Operation ID: admin.companies.resources.counts
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/companies/{company}/resources/{kind}

Read bounded safe company resources with verified modern and legacy bindings

Operation ID: admin.companies.resources.list
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/companies/{company}/spam/filters/{filter}

Read a safe customer filter and its current ETag under the real operator identity

Operation ID: admin.spam.filters.get
Required scope: admin:read
Action type: admin

DELETE/api/v1/accounts/{account}/admin/companies/{company}

Archive an empty settled company while retaining users and financial history

Operation ID: admin.companies.archive
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/companies/{company}

Read a platform company and its current version

Operation ID: admin.companies.get
Required scope: admin:read
Action type: admin

PATCH/api/v1/accounts/{account}/admin/companies/{company}

Update company profile and policy with mandate-aware bank safeguards

Operation ID: admin.companies.update
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/companies

Search platform companies without exposing payment credentials

Operation ID: admin.companies.list
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/companies

Create a company and an unverified owner without supplier or mail effects

Operation ID: admin.companies.create
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/dashboard

Read platform dashboard aggregates and safe recent activity after human passkey verification

Operation ID: admin.dashboard.get
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/connections/{id}/actions/assign

Assign or make global an unbound provider connection without exposing its token

Operation ID: admin.dns.connections.assign
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/dns/creation-changes/by-operation/{operation}

Locate an existing original zone creation from its original HTTP receipt

Operation ID: admin.dns.creation-changes.lookup
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/creation-changes/{change}/actions/abandon

Strong administrator SQL-only abandonment of an entirely unattempted original creation

Operation ID: admin.dns.creation-changes.abandon
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/creation-changes/{change}/actions/continue

Strong administrator continuation of never-attempted original creation steps

Operation ID: admin.dns.creation-changes.continue
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/creation-changes/{change}/actions/reconcile

Strong administrator GET-only recovery of the original zone creation

Operation ID: admin.dns.creation-changes.reconcile
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/dns/creation-changes/{change}

Read safe original zone-creation metadata

Operation ID: admin.dns.creation-changes.get
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/dns/publication-changes/by-operation/{operation}

Locate an existing original zone publication from its original HTTP receipt

Operation ID: admin.dns.publication-changes.lookup
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/publication-changes/{change}/actions/abandon

Strong administrator SQL-only abandonment of an entirely unattempted original publication

Operation ID: admin.dns.publication-changes.abandon
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/publication-changes/{change}/actions/continue

Strong administrator continuation of never-attempted original publication steps

Operation ID: admin.dns.publication-changes.continue
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/publication-changes/{change}/actions/reconcile

Strong administrator GET-only recovery of the original zone publication

Operation ID: admin.dns.publication-changes.reconcile
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/dns/publication-changes/{change}

Read safe original zone-publication metadata

Operation ID: admin.dns.publication-changes.get
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/dns/removal-changes/by-operation/{operation}

Locate an existing original zone removal from its original HTTP receipt

Operation ID: admin.dns.removal-changes.lookup
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/removal-changes/{change}/actions/abandon

Strong administrator SQL-only abandonment of an entirely unattempted original removal

Operation ID: admin.dns.removal-changes.abandon
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/removal-changes/{change}/actions/continue

Strong administrator continuation of never-attempted original removal steps

Operation ID: admin.dns.removal-changes.continue
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/removal-changes/{change}/actions/reconcile

Strong administrator GET-only recovery of the original zone removal

Operation ID: admin.dns.removal-changes.reconcile
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/dns/removal-changes/{change}

Read safe original zone-removal metadata

Operation ID: admin.dns.removal-changes.get
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/templates/{id}/actions/assign

Assign a DNS template to an explicit company

Operation ID: admin.dns.templates.assign
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/templates/{id}/actions/visibility

Set explicit global visibility for a validated DNS template

Operation ID: admin.dns.templates.visibility
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/zones/{id}/actions/assign

Move an unbound DNS-only zone with version protection

Operation ID: admin.dns.zones.assign
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/zones/{id}/actions/deactivate

Deactivate DNS for an explicitly selected company while retaining registration and services

Operation ID: admin.dns.zones.deactivate
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/zones/{id}/actions/delete

Delete an unbound DNS-only zone for an explicitly selected company as the real administrator

Operation ID: admin.dns.zones.delete
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/zones/{id}/actions/restore

Publish a stored zone for an explicitly selected company under the real administration identity

Operation ID: admin.dns.zones.restore
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/zones/{id}/actions/rewrite

Rewrite an explicitly selected company zone through the shared original portal lifecycle

Operation ID: admin.dns.zones.rewrite
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/dns/zones

Create an explicitly company-bound DNS-only zone through the portal writer

Operation ID: admin.dns.zones.create
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/dns/{resource}/{id}

Inspect a DNS administration resource without provider secrets

Operation ID: admin.dns.get
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/domains/changes/by-operation/{operation}

Locate the same original registrar or local domain change

Operation ID: admin.domains.changes.lookup
Required scope: admin:read
Action type: Read

POST/api/v1/accounts/{account}/admin/domains/changes/{change}/actions/abandon

Recover the same original without supplier mutations

Operation ID: admin.domains.changes.abandon
Required scope: admin:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/admin/domains/changes/{change}/actions/continue

Continue only never-attempted original domain steps

Operation ID: admin.domains.changes.continue
Required scope: admin:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/admin/domains/changes/{change}/actions/reconcile

Recover the same original without supplier mutations

Operation ID: admin.domains.changes.reconcile
Required scope: admin:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/admin/domains/changes/{change}

Read safe original domain-change status

Operation ID: admin.domains.changes.get
Required scope: admin:read
Action type: Read

GET/api/v1/accounts/{account}/admin/domains/pricing-policy

Read domains default margin and supplier synchronization policy

Operation ID: admin.domains.pricing-policy.get
Required scope: admin:read
Action type: admin

PUT/api/v1/accounts/{account}/admin/domains/pricing-policy

Update domains default margin and optionally future catalog prices

Operation ID: admin.domains.pricing-policy.update
Required scope: admin:write
Action type: admin

DELETE/api/v1/accounts/{account}/admin/domains/products/{product}

Retire a domains catalog choice while preserving historical references

Operation ID: admin.domains.products.retire
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/domains/products/{product}

Read internal domains product configuration

Operation ID: admin.domains.products.get
Required scope: admin:read
Action type: admin

PATCH/api/v1/accounts/{account}/admin/domains/products/{product}

Update domains catalog configuration for future orders

Operation ID: admin.domains.products.update
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/domains/products

List internal domains catalog prices and configuration

Operation ID: admin.domains.products.list
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/domains/products

Create a domains catalog product

Operation ID: admin.domains.products.create
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/domains/registrar/import

Import or link reviewed registrar identities through the canonical local mapping

Operation ID: admin.domains.registrar.import
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/domains/registrar/portfolio/{provider}

Inspect one registrar identity and local review versions

Operation ID: admin.domains.registrar.portfolio.get
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/domains/registrar/portfolio

Read a bounded registrar inventory without credentials

Operation ID: admin.domains.registrar.portfolio.list
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/domains/registrar/synchronizations/{run}/actions/step

Advance one reviewed bounded phase with an atomic local progress receipt

Operation ID: admin.domains.registrar.sync.step
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/domains/registrar/synchronizations/{run}/original-step-receipt

Read one exact original page receipt after reconnecting; never submit a page or call the supplier

Operation ID: admin.domains.registrar.sync.original-receipt
Required scope: admin:read
Action type: Read

GET/api/v1/accounts/{account}/admin/domains/registrar/synchronizations/{run}

Inspect safe original synchronization progress and its current ETag

Operation ID: admin.domains.registrar.sync.get
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/domains/registrar/synchronizations

Start one source-bound canonical portfolio synchronization without supplier mutations

Operation ID: admin.domains.registrar.sync.start
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/domains/{domain}/actions/cancel

Apply a reviewed original domain cancel change for an explicit target company

Operation ID: admin.domains.cancel
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/domains/{domain}/actions/contacts

Apply a reviewed original domain contacts change for an explicit target company

Operation ID: admin.domains.contacts
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/domains/{domain}/actions/migrate-company-billing

Commit one reviewed original accounting termination and future company billing intent

Operation ID: admin.domains.ownership.wefact.migrate
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/domains/{domain}/actions/nameservers

Apply a reviewed original domain nameservers change for an explicit target company

Operation ID: admin.domains.nameservers
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/domains/{domain}/actions/resume

Apply a reviewed original domain resume change for an explicit target company

Operation ID: admin.domains.resume
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/domains/{domain}/actions/transfer-company

Transfer reviewed local company responsibility while retaining original yearly liabilities and invoices

Operation ID: admin.domains.ownership.transfer
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/domains/{domain}/nameserver-review/{target}/{group}

Review an explicit customer domain and available nameserver group under real operator authority

Operation ID: admin.domains.nameservers.review
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/domains/{domain}/ownership-migrations/{intent}/actions/reconcile

Reconcile the original termination by reads and atomic local finalization, without another supplier mutation

Operation ID: admin.domains.ownership.wefact.reconcile
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/domains/{domain}/ownership-migrations/{intent}

Inspect the original migration UUID without supplier calls

Operation ID: admin.domains.ownership.wefact.get
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/domains/{domain}/ownership-plan

Review exact companies and complete future yearly liabilities without changing ownership

Operation ID: admin.domains.ownership.review
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/domains/{domain}/wefact-ownership-plan

Review the exact paid original WeFact period and future company agreement without changing billing

Operation ID: admin.domains.ownership.wefact.review
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/holders/import

Import one registrar handle into an explicit company

Operation ID: admin.holders.import
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/holders/mutations/{mutation}/actions/abandon

Close only a contact preparation proved never dispatched

Operation ID: admin.holders.mutations.abandon
Required scope: admin:read
Action type: Read

POST/api/v1/accounts/{account}/admin/holders/mutations/{mutation}/actions/reconcile

Verify the original registrar contact with GET only

Operation ID: admin.holders.mutations.reconcile
Required scope: admin:read
Action type: Read

GET/api/v1/accounts/{account}/admin/holders/mutations/{mutation}

Inspect safe original platform contact metadata

Operation ID: admin.holders.mutations.get
Required scope: admin:read
Action type: Read

POST/api/v1/accounts/{account}/admin/holders/{holder}/actions/assign

Move an unused registrar contact with version protection

Operation ID: admin.holders.assign
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/holders/{holder}/domains

Inspect bounded domain contact roles for one registrar contact

Operation ID: admin.holders.domains
Required scope: admin:read
Action type: Read

DELETE/api/v1/accounts/{account}/admin/holders/{holder}

Remove an explicitly reviewed unused registrar contact

Operation ID: admin.holders.delete
Required scope: admin:write
Action type: Destructive

GET/api/v1/accounts/{account}/admin/holders/{holder}

Inspect a registrar contact for explicit internal assignment

Operation ID: admin.holders.get
Required scope: admin:read
Action type: admin

PUT/api/v1/accounts/{account}/admin/holders/{holder}

Replace public contact fields through the original registrar journal

Operation ID: admin.holders.update
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/holders

List public registrar contact fields for platform administration

Operation ID: admin.holders.list
Required scope: admin:read
Action type: Read

POST/api/v1/accounts/{account}/admin/holders

Create a registrar contact for an explicitly reviewed company

Operation ID: admin.holders.create
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/hosting/imports/inspect

Inspect exact configured supplier metadata and review target ownership and separate customer coverage without supplier writes

Operation ID: admin.hosting.imports.review
Required scope: admin:read
Action type: Read

GET/api/v1/accounts/{account}/admin/hosting/imports/{intent}

Recover this actor and context original Hosting import receipt without supplier reads

Operation ID: admin.hosting.imports.get
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/hosting/imports

Import reviewed existing Hosting and children atomically without changing provider passwords DNS registration or billing

Operation ID: admin.hosting.imports.commit
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/hosting/packages/{package}/actions/continue

Continue unattempted revisions without resending an uncertain supplier action

Operation ID: admin.hosting.packages.continue
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/hosting/packages/{package}/actions/reconcile

Read back uncertain provider plans without issuing ADD, SET or DEL

Operation ID: admin.hosting.packages.reconcile
Required scope: admin:write
Action type: admin

DELETE/api/v1/accounts/{account}/admin/hosting/packages/{package}

Retire a hosting package while preserving subscription and provider-plan history

Operation ID: admin.hosting.packages.retire
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/hosting/packages/{package}

Read hosting package configuration, revision state and version

Operation ID: admin.hosting.packages.get
Required scope: admin:read
Action type: admin

PUT/api/v1/accounts/{account}/admin/hosting/packages/{package}

Publish future-only hosting package configuration without changing existing quotas

Operation ID: admin.hosting.packages.update
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/hosting/packages

Inspect hosting packages and immutable provider-plan revisions

Operation ID: admin.hosting.packages.list
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/hosting/packages

Publish a verified Plesk plan revision for future hosting orders

Operation ID: admin.hosting.packages.create
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/hosting/pricing-policy

Read hosting default margin and supplier synchronization policy

Operation ID: admin.hosting.pricing-policy.get
Required scope: admin:read
Action type: admin

PUT/api/v1/accounts/{account}/admin/hosting/pricing-policy

Update hosting default margin and optionally future catalog prices

Operation ID: admin.hosting.pricing-policy.update
Required scope: admin:write
Action type: admin

DELETE/api/v1/accounts/{account}/admin/hosting/servers/{server}

Delete hosting provider configuration without exposing credentials

Operation ID: admin.hosting.servers.delete
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/hosting/servers/{server}

Get hosting provider configuration without exposing credentials

Operation ID: admin.hosting.servers.get
Required scope: admin:read
Action type: admin

PATCH/api/v1/accounts/{account}/admin/hosting/servers/{server}

Update hosting provider configuration without exposing credentials

Operation ID: admin.hosting.servers.update
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/hosting/servers

List hosting provider configuration without exposing credentials

Operation ID: admin.hosting.servers.list
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/hosting/servers

Create hosting provider configuration without exposing credentials

Operation ID: admin.hosting.servers.create
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/hosting/subscriptions/{subscription}/actions/confirm-no-portal-billing

Audit an explicit investigation that this portal does not automate billing without changing external agreements

Operation ID: admin.hosting.imports.billing.confirm
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/hosting/subscriptions/{subscription}/import-billing

Read the existing Hosting import billing review

Operation ID: admin.hosting.imports.billing.get
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/legacy-payments/{payment}

Read historical payment metadata without transactions or inferred currency

Operation ID: admin.legacy-payments.get
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/legacy-payments

Read bounded historical payment metadata; processed is not paid

Operation ID: admin.legacy-payments.list
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/mail-test

Inspect the current verified administrator recipient and mail test version

Operation ID: admin.mail-test.get
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/mail-tests/{intent}

Inspect the original mail test without resending it

Operation ID: admin.mail-test.status
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/mail-tests

Submit one explicit mail test to the current verified administrator

Operation ID: admin.mail-test.send
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/portal-logs/{log}

Read explicitly allowed historical fields without decrypting secrets

Operation ID: admin.portal-logs.get
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/portal-logs

Read safe global portal event metadata with explicit filters

Operation ID: admin.portal-logs.list
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/portal-settings

Read the global public portal name and contact email

Operation ID: admin.portal-settings.get
Required scope: admin:read
Action type: admin

PUT/api/v1/accounts/{account}/admin/portal-settings

Update explicitly confirmed global public branding

Operation ID: admin.portal-settings.update
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/spam/assignments/review

Review local unbound filtering ownership without changing DNS or billing

Operation ID: admin.spam.assignments.review
Required scope: admin:read
Action type: Read

POST/api/v1/accounts/{account}/admin/spam/assignments

Assign reviewed unbound filter metadata with exact source and target company versions

Operation ID: admin.spam.assignments.commit
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/spam/configuration-changes/{change}/actions/continue

Explicit original administrator continuation of never-attempted browser filtering phases

Operation ID: admin.spam.configuration-changes.continue
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/spam/configuration-changes/{change}/actions/reconcile

Strong original administrator GET-only filtering reconciliation and local publication

Operation ID: admin.spam.configuration-changes.reconcile
Required scope: admin:read
Action type: Read

GET/api/v1/accounts/{account}/admin/spam/configuration-changes/{change}

Read the same signed administrator browser filtering original in its actual context

Operation ID: admin.spam.configuration-changes.get
Required scope: admin:read
Action type: Read

POST/api/v1/accounts/{account}/admin/spam/filters/{filter}/actions/confirm-no-portal-billing

Audit an explicit investigation confirming no automatic portal billing agreement

Operation ID: admin.spam.imports.billing.confirm
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/spam/filters/{filter}/actions/delete

Delete an explicit customer filter through the shared billing, DNS and supplier journal

Operation ID: admin.spam.filters.delete
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/spam/filters/{filter}/actions/restore-dns

Restore the original reviewed customer MX through the shared filtering journal

Operation ID: admin.spam.filters.restore-dns
Required scope: admin:write
Action type: admin

PUT/api/v1/accounts/{account}/admin/spam/filters/{filter}/configuration

Configure an explicit customer filter from the real operator context

Operation ID: admin.spam.filters.configure
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/spam/filters/{filter}/import-billing

Read the imported spam filter billing review receipt

Operation ID: admin.spam.imports.billing.get
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/spam/imports/inspect

Review an existing spam filter, target ownership and explicitly recorded coverage

Operation ID: admin.spam.imports.review
Required scope: admin:read
Action type: Read

POST/api/v1/accounts/{account}/admin/spam/imports

Import reviewed spam-filter metadata atomically without supplier writes or assumed billing

Operation ID: admin.spam.imports.commit
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/spam/pricing-policy

Read spam default margin and supplier synchronization policy

Operation ID: admin.spam.pricing-policy.get
Required scope: admin:read
Action type: admin

PUT/api/v1/accounts/{account}/admin/spam/pricing-policy

Update spam default margin and optionally future catalog prices

Operation ID: admin.spam.pricing-policy.update
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/spam/products/{product}

Read internal spam product configuration

Operation ID: admin.spam.products.get
Required scope: admin:read
Action type: admin

PATCH/api/v1/accounts/{account}/admin/spam/products/{product}

Update spam catalog configuration for future orders

Operation ID: admin.spam.products.update
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/spam/products

List internal spam catalog prices and configuration

Operation ID: admin.spam.products.list
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/ssl/pricing-policy

Read ssl default margin and supplier synchronization policy

Operation ID: admin.ssl.pricing-policy.get
Required scope: admin:read
Action type: admin

PUT/api/v1/accounts/{account}/admin/ssl/pricing-policy

Update ssl default margin and optionally future catalog prices

Operation ID: admin.ssl.pricing-policy.update
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/users/actions/bulk

Apply one atomic reviewed local selection without deleting history or silently restoring access

Operation ID: admin.users.bulk
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/users/{user}/actions/block

Disable memberships after verifying remaining company ownership

Operation ID: admin.users.block
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/users/{user}/actions/send-setup-email

Submit one setup message after explicit current identity approval

Operation ID: admin.users.send-setup-email
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/users/{user}/actions/unblock

Restore disabled memberships without reviving expired access

Operation ID: admin.users.unblock
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/users/{user}/mail-deliveries

Inspect bounded delivery metadata without a recovery link or message body

Operation ID: admin.users.mail-deliveries.list
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/users/{user}/memberships

Page through actual company memberships of a human user

Operation ID: admin.users.memberships.list
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/users/{user}/unblock-reviews

Read only changed original blocked memberships with exact current permissions for explicit restoration review

Operation ID: admin.users.unblock-reviews.list
Required scope: admin:read
Action type: admin

DELETE/api/v1/accounts/{account}/admin/users/{user}

Archive an eligible human identity and revoke its personal connections

Operation ID: admin.users.archive
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/users/{user}

Read human profile and exact company memberships

Operation ID: admin.users.get
Required scope: admin:read
Action type: admin

PATCH/api/v1/accounts/{account}/admin/users/{user}

Update a human profile or administration role without bypassing verified email changes

Operation ID: admin.users.update
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/users

Search actual human users without credentials or recovery links

Operation ID: admin.users.list
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/wefact/companies/{company}/contact-resolution

Find this human’s original company contact resolution after a lost response

Operation ID: admin.wefact.contacts.resolutions.current
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/wefact/companies/{company}/contact-resolutions/{resolution}/actions/reconcile

Reconcile the same original contact using exact supplier reads without another add; current admin write privilege is also required

Operation ID: admin.wefact.contacts.resolutions.reconcile
Required scope: admin:read
Action type: Read

POST/api/v1/accounts/{account}/admin/wefact/companies/{company}/contact-resolutions/{resolution}/actions/resume

Resume only the same proven never-dispatched original reservation after a fresh exact review

Operation ID: admin.wefact.contacts.resolutions.resume
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/wefact/companies/{company}/contact-resolutions/{resolution}

Inspect original accounting contact metadata without supplier reads

Operation ID: admin.wefact.contacts.resolutions.get
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/wefact/contact-ensure

Ensure one reviewed company contact using its original company-unique resolution

Operation ID: admin.wefact.contacts.ensure
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/wefact/contact-review

Review the exact current company contact without supplier reads or creation

Operation ID: admin.wefact.contacts.ensure.review
Required scope: admin:read
Action type: Read

GET/api/v1/accounts/{account}/admin/wefact/contacts/{contact}

Read one exact accounting contact identity

Operation ID: admin.wefact.contacts.get
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/wefact/contacts

Read a bounded accounting contact page without bank or mandate values

Operation ID: admin.wefact.contacts.list
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/wefact/import-review

Review one exact new company and owner recipient without creating anything

Operation ID: admin.wefact.import.review
Required scope: admin:read
Action type: Read

GET/api/v1/accounts/{account}/admin/wefact/imports/{import}

Recover one original import without supplier reads or welcome submission

Operation ID: admin.wefact.imports.get
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/wefact/imports

Read bounded original import receipts for this actor and administration context

Operation ID: admin.wefact.imports.list
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/wefact/imports

Import all explicitly reviewed companies atomically and retain their original receipt

Operation ID: admin.wefact.imports.create
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/wefact/link-review

Review an explicit company and accounting contact without writing

Operation ID: admin.wefact.link.review
Required scope: admin:read
Action type: Read

POST/api/v1/accounts/{account}/admin/wefact/link

Link one explicitly reviewed contact without changing bank, identity or supplier data

Operation ID: admin.wefact.link
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/wefact/suggestions/{suggestion}/actions/reject

Reject one current local suggestion without touching supplier data

Operation ID: admin.wefact.suggestions.reject
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/wefact/suggestions

Read bounded unverified local match identifiers without cached personal data

Operation ID: admin.wefact.suggestions.list
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/wefact

Read local accounting overview counts and connection availability

Operation ID: admin.wefact.overview
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/workspace/adoptions/inspect

Inspect exact existing mail identities and review explicit future adoption billing without provider writes

Operation ID: admin.workspace.adoptions.inspect
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/adoptions/inspect

Read-only JSON review of bounded exact provider identities and future adoption billing

Operation ID: admin.workspace.adoptions.review
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/adoptions

Adopt the reviewed provider identities and atomically queue authorized native synchronization

Operation ID: admin.workspace.adoptions.commit
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/credential-claims/{secret}/consume

Consume an approved Workspace installer token once and erase the claim

Operation ID: admin.workspace.server.credentials.consume
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/packages/actions/synchronize

Add configured Workspace packages and retire old choices while preserving existing products

Operation ID: admin.workspace.packages.synchronize
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/workspace/packages

Inspect Workspace package configuration without repricing existing subscriptions

Operation ID: admin.workspace.packages.list
Required scope: admin:read
Action type: admin

PUT/api/v1/accounts/{account}/admin/workspace/packages

Update Workspace package prices and product codes for future orders

Operation ID: admin.workspace.packages.update
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/servers/{server}/actions/installer-token

Approve one exact pending installer and deliver its token through a one-time claim

Operation ID: admin.workspace.servers.installer-token
Required scope: admin:write
Action type: admin

DELETE/api/v1/accounts/{account}/admin/workspace/servers/{server}

Remove unused portal server configuration without deleting the supplier server

Operation ID: admin.workspace.servers.delete
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/workspace/servers/{server}

Read a Workspace server configuration and version without credentials

Operation ID: admin.workspace.servers.get
Required scope: admin:read
Action type: admin

PUT/api/v1/accounts/{account}/admin/workspace/servers/{server}

Update server settings without silently rerouting existing resources

Operation ID: admin.workspace.servers.update
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/workspace/servers

List internal Workspace server configuration without credentials

Operation ID: admin.workspace.servers.list
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/servers

Create an explicitly bound Workspace server configuration

Operation ID: admin.workspace.servers.create
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/workspaces/{workspace}/actions/conserio-resync

Approve Workspace conserio-resync through native workers without changing billing

Operation ID: admin.workspace.workspaces.conserio-resync
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/workspaces/{workspace}/actions/reapprove

Explicitly reapprove held platform tasks of the original Workspace administration operation

Operation ID: admin.workspace.workspaces.reapprove
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/workspaces/{workspace}/actions/resume

Approve Workspace resume through native workers without changing billing

Operation ID: admin.workspace.workspaces.resume
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/workspaces/{workspace}/actions/suspend

Approve Workspace suspend through native workers without changing billing

Operation ID: admin.workspace.workspaces.suspend
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/workspaces/{workspace}/actions/transfer

Transfer future Workspace responsibility with a reviewed immutable history receipt

Operation ID: admin.workspace.workspaces.transfer
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/workspaces/{workspace}/portal-approvals/{intent}/reapprove

Explicitly renew the same original browser maintenance tasks

Operation ID: admin.workspace.portal-approvals.reapprove
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/workspace/workspaces/{workspace}/portal-approvals/{intent}

Inspect original browser maintenance without supplier requests

Operation ID: admin.workspace.portal-approvals.get
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/workspace/workspaces/{workspace}/transfer-plan

Review exact future company billing without changing ownership

Operation ID: admin.workspace.workspaces.transfer-plan
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/workspace/workspaces/{workspace}

Read a Workspace administration version and company binding

Operation ID: admin.workspace.workspaces.get
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/admin/workspace/workspaces

List platform Workspaces without credentials

Operation ID: admin.workspace.workspaces.list
Required scope: admin:read
Action type: admin

GET/api/v1/accounts/{account}/audit-events

Read company API audit events

Operation ID: audit.list
Required scope: audit:read
Action type: Standard action

GET/api/v1/accounts/{account}/billing/invoices/{id}

Get billing invoices

Operation ID: billing.invoices.get
Required scope: billing.invoices:read
Action type: Standard action

POST/api/v1/accounts/{account}/billing/invoices/{invoice}/pay

Start a secure hosted invoice payment

Operation ID: billing.invoices.pay
Required scope: billing.invoices:pay
Action type: Standard action

GET/api/v1/accounts/{account}/billing/invoices/{invoice}/pdf

Download an invoice PDF

Operation ID: billing.invoices.pdf
Required scope: billing.invoices:read
Action type: Standard action

GET/api/v1/accounts/{account}/billing/invoices

List billing invoices

Operation ID: billing.invoices.list
Required scope: billing.invoices:read
Action type: Standard action

GET/api/v1/accounts/{account}/billing/items/{id}

Get billing items

Operation ID: billing.items.get
Required scope: billing:read
Action type: Standard action

GET/api/v1/accounts/{account}/billing/items

List billing items

Operation ID: billing.items.list
Required scope: billing:read
Action type: Standard action

GET/api/v1/accounts/{account}/billing/renewal-forecast

Read a bounded catalogue-price forecast of current service periods, separate from invoices

Operation ID: billing.renewal-forecast.list
Required scope: billing:read
Action type: Read

GET/api/v1/accounts/{account}/billing/upcoming-transactions/{id}

Get billing upcoming-transactions

Operation ID: billing.upcoming-transactions.get
Required scope: billing:read
Action type: Standard action

GET/api/v1/accounts/{account}/billing/upcoming-transactions

List billing upcoming-transactions

Operation ID: billing.upcoming-transactions.list
Required scope: billing:read
Action type: Standard action

GET/api/v1/accounts/{account}/catalog/domain-extensions/featured

Read the same ordered top-50 extension selection as portal registration

Operation ID: catalog.domain-extensions.featured
Required scope: products:read
Action type: Standard action

GET/api/v1/accounts/{account}/catalog/domain-extensions

List public domain prices and enabled/featured metadata without internal costs

Operation ID: catalog.domain-extensions.list
Required scope: products:read
Action type: Standard action

GET/api/v1/accounts/{account}/dashboard

Read company counts and registration distribution, with separately authorized team and activity metadata

Operation ID: dashboard.get
Required scope: dashboard:read
Action type: Read

POST/api/v1/accounts/{account}/dns/change-plans/{plan}/actions/abandon

Explicit strong owner abandonment of a never-attempted original DNS plan

Operation ID: dns.change-plans.abandon
Required scope: dns.records:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/change-plans/{plan}/actions/continue

Explicit strong owner continuation of never-attempted original DNS steps

Operation ID: dns.change-plans.continue
Required scope: dns.records:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/change-plans/{plan}/actions/reconcile

Explicit strong owner read-only original DNS reconciliation

Operation ID: dns.change-plans.reconcile
Required scope: dns.records:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/change-plans/{plan}/apply

Apply a reviewed DNS change plan

Operation ID: dns.change-plans.apply
Required scope: dns.records:write
Action type: Standard action

GET/api/v1/accounts/{account}/dns/change-plans/{plan}

Read safe original DNS plan/application metadata

Operation ID: dns.change-plans.get
Required scope: dns.records:read
Action type: Standard action

POST/api/v1/accounts/{account}/dns/change-plans

Validate and preview DNS changes

Operation ID: dns.change-plans.create
Required scope: dns.records:write
Action type: Standard action

GET/api/v1/accounts/{account}/dns/connection-changes/by-operation/{operation}

Locate an existing original provider connection from its original HTTP receipt

Operation ID: dns.connection-changes.lookup
Required scope: dns.connections:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/connection-changes/{change}/actions/abandon

Strong owner SQL-only abandonment of an entirely unattempted original connection

Operation ID: dns.connection-changes.abandon
Required scope: dns.connections:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/connection-changes/{change}/actions/continue

Strong owner continuation of never-attempted original connection steps

Operation ID: dns.connection-changes.continue
Required scope: dns.connections:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/connection-changes/{change}/actions/reconcile

Strong owner GET-only recovery of the original provider connection

Operation ID: dns.connection-changes.reconcile
Required scope: dns.connections:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/dns/connection-changes/{change}

Read safe original provider-connection metadata

Operation ID: dns.connection-changes.get
Required scope: dns.connections:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/connections/{connection}/actions/sync

Review matching current company domains without linking or changing a source

Operation ID: dns.connections.sync
Required scope: dns.connections:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/connections/{connection}/actions/verify

Verify the stored DNS provider credential

Operation ID: dns.connections.verify
Required scope: dns.connections:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/dns/connections/{connection}/domains

Read currently owned domains linked to this connection

Operation ID: dns.connections.domains
Required scope: dns.connections:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/dns/connections/{connection}/zones

Read currently owned zones available on this provider connection

Operation ID: dns.connections.zones
Required scope: dns.connections:read
Action type: Sensitive action requiring extra verification

DELETE/api/v1/accounts/{account}/dns/connections/{connection}

Delete an unlinked connection after individually reviewed zone detaches

Operation ID: dns.connections.delete
Required scope: dns.connections:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/dns/connections/{connection}

Read DNS provider connection metadata

Operation ID: dns.connections.get
Required scope: dns.connections:read
Action type: Sensitive action requiring extra verification

PATCH/api/v1/accounts/{account}/dns/connections/{connection}

Update a company DNS provider connection

Operation ID: dns.connections.update
Required scope: dns.connections:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/dns/connections

List company DNS provider connections without credentials

Operation ID: dns.connections.list
Required scope: dns.connections:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/connections

Store a verified company Cloudflare credential without returning it

Operation ID: dns.connections.create
Required scope: dns.connections:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/exports

Export selected owned DNS zones without changing records

Operation ID: dns.records.export-many
Required scope: dns.records:read
Action type: Read

GET/api/v1/accounts/{account}/dns/nameserver-changes/by-operation/{operation}

Locate the same original registrar or local domain change

Operation ID: dns.nameserver-changes.lookup
Required scope: dns.zones:read
Action type: Read

POST/api/v1/accounts/{account}/dns/nameserver-changes/{change}/actions/abandon

Recover the same original without supplier mutations

Operation ID: dns.nameserver-changes.abandon
Required scope: dns.zones:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/nameserver-changes/{change}/actions/continue

Continue only never-attempted original domain steps

Operation ID: dns.nameserver-changes.continue
Required scope: dns.zones:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/nameserver-changes/{change}/actions/reconcile

Recover the same original without supplier mutations

Operation ID: dns.nameserver-changes.reconcile
Required scope: dns.zones:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/dns/nameserver-changes/{change}

Read safe original domain-change status

Operation ID: dns.nameserver-changes.get
Required scope: dns.zones:read
Action type: Read

GET/api/v1/accounts/{account}/dns/nameserver-groups/{id}/zones

List accessible zones using this nameserver group

Operation ID: dns.nameserver-groups.zones
Required scope: dns.nameservers:read
Action type: Standard action

DELETE/api/v1/accounts/{account}/dns/nameserver-groups/{id}

Delete an owned DNS nameserver-groups

Operation ID: dns.nameserver-groups.delete
Required scope: dns.nameservers:write
Action type: Standard action

GET/api/v1/accounts/{account}/dns/nameserver-groups/{id}

Get dns nameserver-groups

Operation ID: dns.nameserver-groups.get
Required scope: dns.nameservers:read
Action type: Standard action

PATCH/api/v1/accounts/{account}/dns/nameserver-groups/{id}

Update an owned DNS nameserver-groups

Operation ID: dns.nameserver-groups.update
Required scope: dns.nameservers:write
Action type: Standard action

GET/api/v1/accounts/{account}/dns/nameserver-groups

List dns nameserver-groups

Operation ID: dns.nameserver-groups.list
Required scope: dns.nameservers:read
Action type: Standard action

POST/api/v1/accounts/{account}/dns/nameserver-groups

Create an owned DNS nameserver-groups

Operation ID: dns.nameserver-groups.create
Required scope: dns.nameservers:write
Action type: Standard action

GET/api/v1/accounts/{account}/dns/publication-changes/by-operation/{operation}

Locate an existing original zone publication from its original HTTP receipt

Operation ID: dns.publication-changes.lookup
Required scope: dns.records:read
Action type: Standard action

POST/api/v1/accounts/{account}/dns/publication-changes/{change}/actions/abandon

Strong owner SQL-only abandonment of an entirely unattempted original connection

Operation ID: dns.publication-changes.abandon
Required scope: dns.records:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/publication-changes/{change}/actions/continue

Strong owner continuation of never-attempted original connection steps

Operation ID: dns.publication-changes.continue
Required scope: dns.records:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/publication-changes/{change}/actions/reconcile

Strong owner GET-only recovery of the original zone publication

Operation ID: dns.publication-changes.reconcile
Required scope: dns.records:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/dns/publication-changes/{change}

Read safe original zone-publication metadata

Operation ID: dns.publication-changes.get
Required scope: dns.records:read
Action type: Standard action

GET/api/v1/accounts/{account}/dns/records/search

Search record values in accessible zones with bounded pagination

Operation ID: dns.records.search
Required scope: dns.records:read
Action type: Standard action

GET/api/v1/accounts/{account}/dns/removal-changes/by-operation/{operation}

Locate an existing original zone removal from its original HTTP receipt

Operation ID: dns.removal-changes.lookup
Required scope: dns.zones:read
Action type: Standard action

POST/api/v1/accounts/{account}/dns/removal-changes/{change}/actions/abandon

Strong owner SQL-only abandonment of an entirely unattempted original removal

Operation ID: dns.removal-changes.abandon
Required scope: dns.zones:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/removal-changes/{change}/actions/continue

Strong owner continuation of never-attempted original removal steps

Operation ID: dns.removal-changes.continue
Required scope: dns.zones:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/removal-changes/{change}/actions/reconcile

Strong owner GET-only recovery of the original zone removal

Operation ID: dns.removal-changes.reconcile
Required scope: dns.zones:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/dns/removal-changes/{change}

Read safe original zone-removal metadata

Operation ID: dns.removal-changes.get
Required scope: dns.zones:read
Action type: Standard action

POST/api/v1/accounts/{account}/dns/templates/{id}/duplicate

Copy an accessible DNS template into this company

Operation ID: dns.templates.duplicate
Required scope: dns.templates:write
Action type: Standard action

DELETE/api/v1/accounts/{account}/dns/templates/{id}

Delete an owned DNS templates

Operation ID: dns.templates.delete
Required scope: dns.templates:write
Action type: Standard action

GET/api/v1/accounts/{account}/dns/templates/{id}

Get dns templates

Operation ID: dns.templates.get
Required scope: dns.templates:read
Action type: Standard action

PATCH/api/v1/accounts/{account}/dns/templates/{id}

Update an owned DNS templates

Operation ID: dns.templates.update
Required scope: dns.templates:write
Action type: Standard action

GET/api/v1/accounts/{account}/dns/templates

List dns templates

Operation ID: dns.templates.list
Required scope: dns.templates:read
Action type: Standard action

POST/api/v1/accounts/{account}/dns/templates

Create an owned DNS templates

Operation ID: dns.templates.create
Required scope: dns.templates:write
Action type: Standard action

POST/api/v1/accounts/{account}/dns/versions/{id}/change-plan

Propose restoring a DNS version

Operation ID: dns.versions.restore-plan
Required scope: dns.records:write
Action type: Standard action

GET/api/v1/accounts/{account}/dns/versions/{id}/records

Read a version snapshot without provider metadata

Operation ID: dns.versions.records
Required scope: dns.records:read
Action type: Standard action

GET/api/v1/accounts/{account}/dns/versions/{id}

Get dns versions

Operation ID: dns.versions.get
Required scope: dns.zones:read
Action type: Standard action

GET/api/v1/accounts/{account}/dns/versions

List dns versions

Operation ID: dns.versions.list
Required scope: dns.zones:read
Action type: Standard action

GET/api/v1/accounts/{account}/dns/zones/{id}

Get dns zones

Operation ID: dns.zones.get
Required scope: dns.zones:read
Action type: Standard action

POST/api/v1/accounts/{account}/dns/zones/{zone}/actions/deactivate

Deactivate DNS while preserving registration, service and billing records

Operation ID: dns.zones.deactivate
Required scope: dns.zones:write
Action type: Destructive

POST/api/v1/accounts/{account}/dns/zones/{zone}/actions/nameservers

Select an owned or public nameserver group

Operation ID: dns.zones.nameservers
Required scope: dns.zones:write
Action type: Standard action

POST/api/v1/accounts/{account}/dns/zones/{zone}/actions/restore

Push stored DNS records to their managed provider

Operation ID: dns.zones.restore
Required scope: dns.records:write
Action type: Standard action

POST/api/v1/accounts/{account}/dns/zones/{zone}/actions/rewrite

Reconcile the managed DNS provider with the stored zone

Operation ID: dns.zones.rewrite
Required scope: dns.records:write
Action type: Standard action

POST/api/v1/accounts/{account}/dns/zones/{zone}/connection/actions/pull

Import the owned provider snapshot through portal DNS history and version checks

Operation ID: dns.connections.pull
Required scope: dns.connections:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/dns/zones/{zone}/connection/comparison

Compare the owned provider zone with portal records

Operation ID: dns.connections.compare
Required scope: dns.connections:read
Action type: Sensitive action requiring extra verification

DELETE/api/v1/accounts/{account}/dns/zones/{zone}/connection

Detach provider management without deleting the provider zone

Operation ID: dns.connections.detach
Required scope: dns.connections:write
Action type: Sensitive action requiring extra verification

PUT/api/v1/accounts/{account}/dns/zones/{zone}/connection

Attach a provider connection and explicitly choose push, pull or no record synchronization

Operation ID: dns.connections.attach
Required scope: dns.connections:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/zones/{zone}/copy-plans

Propose copying records from an owned DNS zone

Operation ID: dns.records.copy-plan
Required scope: dns.records:write
Action type: Standard action

GET/api/v1/accounts/{account}/dns/zones/{zone}/export

Export DNS records

Operation ID: dns.records.export
Required scope: dns.records:read
Action type: Standard action

POST/api/v1/accounts/{account}/dns/zones/{zone}/import-plans

Parse and propose importing DNS records

Operation ID: dns.records.import-plan
Required scope: dns.records:write
Action type: Standard action

DELETE/api/v1/accounts/{account}/dns/zones/{zone}/records/{record}

Delete one DNS record through its original canonical journal

Operation ID: dns.records.delete
Required scope: dns.records:write
Action type: Standard action

PATCH/api/v1/accounts/{account}/dns/zones/{zone}/records/{record}

Update one DNS record through its original canonical journal

Operation ID: dns.records.update
Required scope: dns.records:write
Action type: Standard action

GET/api/v1/accounts/{account}/dns/zones/{zone}/records

Read zone records and version

Operation ID: dns.records.list
Required scope: dns.records:read
Action type: Standard action

POST/api/v1/accounts/{account}/dns/zones/{zone}/records

Create one DNS record through its original canonical journal

Operation ID: dns.records.create
Required scope: dns.records:write
Action type: Standard action

POST/api/v1/accounts/{account}/dns/zones/{zone}/replace-plans

Propose literal case-insensitive replacement of DNS record values

Operation ID: dns.records.replace-plan
Required scope: dns.records:write
Action type: Standard action

POST/api/v1/accounts/{account}/dns/zones/{zone}/scheduled-change/actions/abandon

Strong owner SQL-only abandonment of a never-attempted scheduled DNS delivery

Operation ID: dns.schedules.abandon
Required scope: dns.records:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/zones/{zone}/scheduled-change/actions/continue

Strong owner continuation of never-attempted steps of the original scheduled DNS delivery

Operation ID: dns.schedules.continue
Required scope: dns.records:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/zones/{zone}/scheduled-change/actions/pause

Pause scheduled DNS changes

Operation ID: dns.schedules.pause
Required scope: dns.records:write
Action type: Standard action

POST/api/v1/accounts/{account}/dns/zones/{zone}/scheduled-change/actions/reconcile

Strong owner read-only reconciliation of the original scheduled DNS delivery

Operation ID: dns.schedules.reconcile
Required scope: dns.records:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/dns/zones/{zone}/scheduled-change/actions/resume

Resume scheduled DNS changes at a future time

Operation ID: dns.schedules.resume
Required scope: dns.records:write
Action type: Standard action

DELETE/api/v1/accounts/{account}/dns/zones/{zone}/scheduled-change

Cancel scheduled DNS changes

Operation ID: dns.schedules.cancel
Required scope: dns.records:write
Action type: Standard action

GET/api/v1/accounts/{account}/dns/zones/{zone}/scheduled-change

Read pending or last scheduled DNS work

Operation ID: dns.schedules.get
Required scope: dns.records:read
Action type: Standard action

PUT/api/v1/accounts/{account}/dns/zones/{zone}/scheduled-change

Validate and schedule DNS changes

Operation ID: dns.schedules.put
Required scope: dns.records:write
Action type: Standard action

POST/api/v1/accounts/{account}/dns/zones/{zone}/template-plans

Propose applying an accessible DNS template

Operation ID: dns.templates.apply-plan
Required scope: dns.records:write
Action type: Standard action

POST/api/v1/accounts/{account}/dns/zones/{zone}/templates

Save the current owned zone as a validated private DNS template

Operation ID: dns.templates.from-zone
Required scope: dns.templates:write
Action type: Standard action

POST/api/v1/accounts/{account}/dns/zones/{zone}/versions

Create a manual DNS backup

Operation ID: dns.versions.create
Required scope: dns.records:write
Action type: Standard action

DELETE/api/v1/accounts/{account}/dns/zones/{zone}

Remove an unregistered DNS-only zone with no service or billing bindings

Operation ID: dns.zones.delete
Required scope: dns.zones:write
Action type: Destructive

GET/api/v1/accounts/{account}/dns/zones

List dns zones

Operation ID: dns.zones.list
Required scope: dns.zones:read
Action type: Standard action

GET/api/v1/accounts/{account}/domains/changes/by-operation/{operation}

Locate the same original registrar or local domain change

Operation ID: domains.changes.lookup
Required scope: domains:read
Action type: Read

POST/api/v1/accounts/{account}/domains/changes/{change}/actions/abandon

Recover the same original without supplier mutations

Operation ID: domains.changes.abandon
Required scope: domains:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/domains/changes/{change}/actions/continue

Continue only never-attempted original domain steps

Operation ID: domains.changes.continue
Required scope: domains:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/domains/changes/{change}/actions/reconcile

Recover the same original without supplier mutations

Operation ID: domains.changes.reconcile
Required scope: domains:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/domains/changes/{change}

Read safe original domain-change status

Operation ID: domains.changes.get
Required scope: domains:read
Action type: Read

POST/api/v1/accounts/{account}/domains/check

Check registration availability for up to 20 names

Operation ID: domains.check
Required scope: domains:read
Action type: Read

POST/api/v1/accounts/{account}/domains/credential-claims/{secret}/consume

Consume a transfer code once; never replayed

Operation ID: domains.credentials.consume
Required scope: domains.credentials:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/domains/options/nameserver-groups/{group}

Read one available nameserver group and its ETag

Operation ID: domains.nameserver-groups.get
Required scope: domains:read
Action type: Read

GET/api/v1/accounts/{account}/domains/options/nameserver-groups

Read available nameserver groups and reviewed versions using domain permissions

Operation ID: domains.nameserver-groups.list
Required scope: domains:read
Action type: Read

POST/api/v1/accounts/{account}/domains/{domain}/actions/cancel

Disable automatic renewal, preserving the registration period

Operation ID: domains.cancel
Required scope: domains:write
Action type: Standard action

POST/api/v1/accounts/{account}/domains/{domain}/actions/contacts

Change domain contacts using owned registrar holders

Operation ID: domains.contacts
Required scope: domains:write
Action type: Standard action

POST/api/v1/accounts/{account}/domains/{domain}/actions/nameservers

Change domain nameservers to an owned group

Operation ID: domains.nameservers
Required scope: domains:write
Action type: Standard action

POST/api/v1/accounts/{account}/domains/{domain}/actions/resume

Resume automatic renewal before the registration period expires

Operation ID: domains.resume
Required scope: domains:write
Action type: Standard action

POST/api/v1/accounts/{account}/domains/{domain}/actions/transfer-code

Create a protected one-time transfer-code claim

Operation ID: domains.transfer-code
Required scope: domains.credentials:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/domains/{domain}/subscription

Read this domain cancellation and existing billing agreement status

Operation ID: domains.subscription
Required scope: domains:read
Action type: Read

GET/api/v1/accounts/{account}/domains/{id}

Get domains

Operation ID: domains.get
Required scope: domains:read
Action type: Standard action

GET/api/v1/accounts/{account}/domains

List domains

Operation ID: domains.list
Required scope: domains:read
Action type: Standard action

POST/api/v1/accounts/{account}/holders/default

Ensure the company default registrar contact from its existing account details

Operation ID: holders.default.ensure
Required scope: holders:write
Action type: Change

POST/api/v1/accounts/{account}/holders/mutations/{mutation}/actions/abandon

Abandon only an original contact preparation proved never dispatched

Operation ID: holders.mutations.abandon
Required scope: holders:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/holders/mutations/{mutation}/actions/reconcile

Verify one original contact with supplier GET only and finish its local receipt

Operation ID: holders.mutations.reconcile
Required scope: holders:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/holders/mutations/{mutation}

Inspect private-safe original contact mutation metadata

Operation ID: holders.mutations.get
Required scope: holders:read
Action type: Read

GET/api/v1/accounts/{account}/holders/{id}/domains

List owned domains linked to this holder

Operation ID: holders.domains.list
Required scope: holders:read
Action type: Read

DELETE/api/v1/accounts/{account}/holders/{id}

Delete an unused registrar contact

Operation ID: holders.delete
Required scope: holders:write
Action type: Destructive

GET/api/v1/accounts/{account}/holders/{id}

Get holders

Operation ID: holders.get
Required scope: holders:read
Action type: Standard action

PUT/api/v1/accounts/{account}/holders/{id}

Replace a registrar contact with version protection

Operation ID: holders.update
Required scope: holders:write
Action type: Change

GET/api/v1/accounts/{account}/holders

List holders

Operation ID: holders.list
Required scope: holders:read
Action type: Standard action

POST/api/v1/accounts/{account}/holders

Create a company registrar contact

Operation ID: holders.create
Required scope: holders:write
Action type: Change

POST/api/v1/accounts/{account}/hosting/credential-claims/{secret}/consume

Consume a hosting credential once and erase it

Operation ID: hosting.credentials.consume
Required scope: hosting.credentials:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/hosting/subscriptions/{id}

Get hosting subscriptions

Operation ID: hosting.subscriptions.get
Required scope: hosting:read
Action type: Standard action

POST/api/v1/accounts/{account}/hosting/subscriptions/{resource}/cancellations/{intent}/actions/reconcile

Read back the original accounting request without repeating it

Operation ID: hosting.cancellations.reconcile
Required scope: hosting:write
Action type: Standard action

GET/api/v1/accounts/{account}/hosting/subscriptions/{resource}/cancellations/{intent}

Inspect an original cancellation receipt

Operation ID: hosting.cancellations.get
Required scope: hosting:read
Action type: Standard action

GET/api/v1/accounts/{account}/hosting/subscriptions/{resource}/cancellations

List original cancellation receipts without supplier calls

Operation ID: hosting.cancellations.list
Required scope: hosting:read
Action type: Standard action

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/actions/block

Apply hosting lifecycle action block

Operation ID: hosting.block
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/actions/cancel

Apply hosting lifecycle action cancel

Operation ID: hosting.cancel
Required scope: hosting:write
Action type: Standard action

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/actions/domain

Apply hosting lifecycle action domain

Operation ID: hosting.domain
Required scope: hosting:write
Action type: Standard action

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/actions/ftp-password-reset

Reset FTP credentials and create a protected one-time claim

Operation ID: hosting.credentials.ftp.reset
Required scope: hosting.credentials:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/actions/ftp-password-reveal

Internal administrators can create a one-time FTP credential claim

Operation ID: hosting.credentials.ftp.reveal
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/actions/install-application

Apply hosting lifecycle action install-application

Operation ID: hosting.install-application
Required scope: hosting:write
Action type: Standard action

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/actions/panel-password-reset

Reset the company hosting panel password

Operation ID: hosting.credentials.panel.reset
Required scope: hosting.credentials:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/actions/panel-password-reveal

Internal administrators can create a one-time panel credential claim

Operation ID: hosting.credentials.panel.reveal
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/actions/purge-reconcile

Reconcile an existing hosting deletion without repeating supplier deletion

Operation ID: hosting.purge.reconcile
Required scope: hosting:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/actions/purge

Permanently delete hosting after confirmed renewal cancellation and supplier ownership verification

Operation ID: hosting.purge
Required scope: hosting:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/actions/resume

Apply hosting lifecycle action resume

Operation ID: hosting.resume
Required scope: hosting:write
Action type: Standard action

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/actions/unblock

Apply hosting lifecycle action unblock

Operation ID: hosting.unblock
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/alias-attempts/{attempt}/actions/reconcile

Read back the original alias without repeating creation or deletion

Operation ID: hosting.alias-attempts.reconcile
Required scope: hosting:write
Action type: Standard action

GET/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/alias-attempts/{attempt}

Inspect the original alias attempt without supplier requests

Operation ID: hosting.alias-attempts.get
Required scope: hosting:read
Action type: Standard action

DELETE/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/aliases/{child}

Remove a hosting child

Operation ID: hosting.aliases.delete
Required scope: hosting:write
Action type: Standard action

GET/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/aliases/{child}

Read a hosting child and version

Operation ID: hosting.aliases.get
Required scope: hosting:read
Action type: Standard action

GET/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/aliases

List hosting aliases

Operation ID: hosting.aliases.list
Required scope: hosting:read
Action type: Standard action

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/aliases

Create a hosting child

Operation ID: hosting.aliases.create
Required scope: hosting:write
Action type: Standard action

GET/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/credentials

Read credential usernames and the credential version without passwords

Operation ID: hosting.credentials.get
Required scope: hosting.credentials:read
Action type: Sensitive action requiring extra verification

DELETE/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/databases/{child}

Remove a hosting child

Operation ID: hosting.databases.delete
Required scope: hosting:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/databases/{child}

Read a hosting child and version

Operation ID: hosting.databases.get
Required scope: hosting:read
Action type: Standard action

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/databases/{database}/users

Create a database-scoped user with recent strong authentication

Operation ID: hosting.databases.users.create
Required scope: hosting.credentials:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/databases

List hosting databases

Operation ID: hosting.databases.list
Required scope: hosting:read
Action type: Standard action

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/databases

Create a hosting child

Operation ID: hosting.databases.create
Required scope: hosting:write
Action type: Standard action

DELETE/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/email-addresses/{child}

Remove a hosting child

Operation ID: hosting.email-addresses.delete
Required scope: hosting:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/email-addresses/{child}

Read a hosting child and version

Operation ID: hosting.email-addresses.get
Required scope: hosting:read
Action type: Standard action

GET/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/email-addresses

List hosting email-addresses

Operation ID: hosting.email-addresses.list
Required scope: hosting:read
Action type: Standard action

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/email-addresses

Create a hosting child

Operation ID: hosting.email-addresses.create
Required scope: hosting.credentials:write
Action type: Sensitive action requiring extra verification

DELETE/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/subdomains/{child}

Remove a hosting child

Operation ID: hosting.subdomains.delete
Required scope: hosting:write
Action type: Standard action

GET/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/subdomains/{child}

Read a hosting child and version

Operation ID: hosting.subdomains.get
Required scope: hosting:read
Action type: Standard action

GET/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/subdomains

List hosting subdomains

Operation ID: hosting.subdomains.list
Required scope: hosting:read
Action type: Standard action

POST/api/v1/accounts/{account}/hosting/subscriptions/{subscription}/subdomains

Create a hosting child

Operation ID: hosting.subdomains.create
Required scope: hosting:write
Action type: Standard action

GET/api/v1/accounts/{account}/hosting/subscriptions

List hosting subscriptions

Operation ID: hosting.subscriptions.list
Required scope: hosting:read
Action type: Standard action

POST/api/v1/accounts/{account}/identity/actions/confirm-email-change

Confirm your own new email and revoke existing personal login sessions

Operation ID: identity.email.confirm
Required scope: identity:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/identity/actions/request-email-change

Send a short-lived code to your proposed new email without changing the login address

Operation ID: identity.email.request
Required scope: identity:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/identity

Read the current human personal identity and pending email confirmation

Operation ID: identity.get
Required scope: identity:read
Action type: Read

PATCH/api/v1/accounts/{account}/identity

Update your own personal name, phone and language after strong verification

Operation ID: identity.update
Required scope: identity:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts

List companies accessible to this grant

Operation ID: identity.accounts
Required scope: account:read
Action type: Standard action

GET/api/v1/me

Describe the authenticated principal

Operation ID: identity.me
Required scope: account:read
Action type: Standard action

GET/api/v1/accounts/{account}/lookups/addresses/{postcode}

Look up Dutch postcode address details through the portal PDOK service

Operation ID: lookups.address
Required scope: account:read
Action type: Standard action

GET/api/v1/accounts/{account}/lookups/mx/{domain}

Look up public MX hostnames and priorities without contacting mailservers

Operation ID: lookups.mx
Required scope: spam:read
Action type: Standard action

POST/api/v1/accounts/{account}/operations/original-receipt

Read metadata for one proven original personal request without replaying it

Operation ID: operations.original-receipt
Required scope: operations:read
Action type: Read

GET/api/v1/accounts/{account}/operations/{id}

Read the status of an operation

Operation ID: operations.get
Required scope: operations:read
Action type: Standard action

POST/api/v1/accounts/{account}/operations/{operation}/reapprove

Reapprove held tasks of the same existing company operation

Operation ID: operations.reapprove
Required scope: orders:commit
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/operations

List operations submitted by this principal

Operation ID: operations.list
Required scope: operations:read
Action type: Standard action

GET/api/v1/accounts/{account}/order-batches/quotes/{quote}

Read the approved company basket and payment plan

Operation ID: orders.batches.quotes.get
Required scope: orders:read
Action type: Standard action

POST/api/v1/accounts/{account}/order-batches/quotes

Review one server-priced company basket of new purchases

Operation ID: orders.batches.quotes.create
Required scope: orders:write
Action type: Standard action

POST/api/v1/accounts/{account}/order-batches

Submit all approved basket items through one company checkout

Operation ID: orders.batches.commit
Required scope: orders:commit
Action type: Standard action

GET/api/v1/accounts/{account}/order-quotes/{quote}

Read this principal approved purchase quote

Operation ID: orders.quotes.get
Required scope: orders:read
Action type: Standard action

POST/api/v1/accounts/{account}/order-quotes

Review a server-priced domain or Workspace purchase

Operation ID: orders.quotes.create
Required scope: orders:write
Action type: Standard action

GET/api/v1/accounts/{account}/orders/{id}

Get orders

Operation ID: orders.get
Required scope: billing:read
Action type: Standard action

GET/api/v1/accounts/{account}/orders

List orders

Operation ID: orders.list
Required scope: billing:read
Action type: Standard action

POST/api/v1/accounts/{account}/orders

Submit an approved quote once with durable idempotency

Operation ID: orders.commit
Required scope: orders:commit
Action type: Standard action

GET/api/v1/accounts/{account}/products/{id}

Get products

Operation ID: products.get
Required scope: products:read
Action type: Standard action

GET/api/v1/accounts/{account}/products

List products

Operation ID: products.list
Required scope: products:read
Action type: Standard action

POST/api/v1/accounts/{account}/spam/configuration-changes/actions/locate

Locate one existing filtering configuration from its exact original HTTP request

Operation ID: spam.configuration-changes.locate
Required scope: spam:read
Action type: Read

POST/api/v1/accounts/{account}/spam/configuration-changes/{change}/actions/continue

Explicit strong owner continuation of never-attempted original filtering phases

Operation ID: spam.configuration-changes.continue
Required scope: spam:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/spam/configuration-changes/{change}/actions/reconcile

Strong owner GET-only original filtering reconciliation and local completion

Operation ID: spam.configuration-changes.reconcile
Required scope: spam:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/spam/configuration-changes/{change}

Read safe original filtering configuration metadata

Operation ID: spam.configuration-changes.get
Required scope: spam:read
Action type: Standard action

POST/api/v1/accounts/{account}/spam/credential-claims/{secret}/consume

Consume a fresh panel URL once without plaintext durable output

Operation ID: spam.credentials.consume
Required scope: spam.panel:open
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/spam/filters/{filter}/actions/cancel

Cancel renewal at the end of the paid period

Operation ID: spam.cancel
Required scope: spam:write
Action type: Standard action

POST/api/v1/accounts/{account}/spam/filters/{filter}/actions/panel

Create an encrypted one-time panel login claim

Operation ID: spam.panel
Required scope: spam.panel:open
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/spam/filters/{filter}/actions/restore-dns

Restore saved MX records only on currently owned zones

Operation ID: spam.restore-dns
Required scope: dns.records:write
Action type: Standard action

POST/api/v1/accounts/{account}/spam/filters/{filter}/actions/resume

Resume renewal within the paid period

Operation ID: spam.resume
Required scope: spam:write
Action type: Standard action

PUT/api/v1/accounts/{account}/spam/filters/{filter}/configuration

Update mail destinations and owned aliases; product changes require a quote

Operation ID: spam.configuration
Required scope: spam:write
Action type: Standard action

DELETE/api/v1/accounts/{account}/spam/filters/{filter}

Delete a supplier filter and optionally restore MX; internal admins only

Operation ID: spam.delete
Required scope: admin:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/spam/filters/{id}

Get spam filters

Operation ID: spam.filters.get
Required scope: spam:read
Action type: Standard action

POST/api/v1/accounts/{account}/spam/filters/{resource}/cancellations/{intent}/actions/reconcile

Read back the original accounting request without repeating it

Operation ID: spam.cancellations.reconcile
Required scope: spam:write
Action type: Standard action

GET/api/v1/accounts/{account}/spam/filters/{resource}/cancellations/{intent}

Inspect an original cancellation receipt

Operation ID: spam.cancellations.get
Required scope: spam:read
Action type: Standard action

GET/api/v1/accounts/{account}/spam/filters/{resource}/cancellations

List original cancellation receipts without supplier calls

Operation ID: spam.cancellations.list
Required scope: spam:read
Action type: Standard action

GET/api/v1/accounts/{account}/spam/filters

List spam filters

Operation ID: spam.filters.list
Required scope: spam:read
Action type: Standard action

POST/api/v1/accounts/{account}/spam/purchases/{purchase}/actions/abandon

Release only a proven never-attempted original purchase without checkout or supplier work

Operation ID: spam.purchases.abandon
Required scope: spam:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/spam/purchases/{purchase}/actions/continue

Explicit original customer continuation of only never-attempted purchase phases

Operation ID: spam.purchases.continue
Required scope: spam:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/spam/purchases/{purchase}/actions/reconcile

Strong original customer GET-only purchase reconciliation and strict local completion

Operation ID: spam.purchases.reconcile
Required scope: spam:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/spam/purchases/{purchase}/actions/renew

Same original human explicitly approves its real current personal connection without another checkout

Operation ID: spam.purchases.renew
Required scope: spam:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/spam/purchases/{purchase}

Read one existing original filtering purchase and its safe delivery state

Operation ID: spam.purchases.get
Required scope: spam:read
Action type: Standard action

POST/api/v1/accounts/{account}/team/invitations/{id}/resend

Resend a pending invitation and replace the acceptance link

Operation ID: team.invitations.resend
Required scope: team:write
Action type: Sensitive action requiring extra verification

DELETE/api/v1/accounts/{account}/team/invitations/{id}

Revoke a pending invitation

Operation ID: team.invitations.revoke
Required scope: team:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/team/invitations

List company invitations without acceptance secrets

Operation ID: team.invitations.list
Required scope: team:read
Action type: Read

POST/api/v1/accounts/{account}/team/invitations

Invite a member with a recent strong human verification

Operation ID: team.invitations.create
Required scope: team:write
Action type: Sensitive action requiring extra verification

DELETE/api/v1/accounts/{account}/team/members/{id}

Remove a non-owner company membership

Operation ID: team.members.remove
Required scope: team:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/team/members/{id}

Get team members

Operation ID: team.members.get
Required scope: team:read
Action type: Standard action

PATCH/api/v1/accounts/{account}/team/members/{id}

Update a non-owner membership within your current permissions

Operation ID: team.members.update
Required scope: team:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/team/members

List team members

Operation ID: team.members.list
Required scope: team:read
Action type: Standard action

POST/api/v1/accounts/{account}/webhooks/credential-claims/{secret}/consume

Consume a signing key once after recent strong authentication

Operation ID: webhooks.credentials.consume
Required scope: webhooks.secret:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/webhooks/{webhook}/actions/rotate

Rotate and pause a webhook; deliver its new key once

Operation ID: webhooks.rotate
Required scope: webhooks.secret:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/webhooks/{webhook}/deliveries

Read bounded delivery statuses without receiver response bodies

Operation ID: webhooks.deliveries
Required scope: webhooks:read
Action type: Read

DELETE/api/v1/accounts/{account}/webhooks/{webhook}

Revoke an endpoint and erase its signing key

Operation ID: webhooks.delete
Required scope: webhooks:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/webhooks/{webhook}

Read public endpoint metadata without its private callback path

Operation ID: webhooks.show
Required scope: webhooks:read
Action type: Read

PATCH/api/v1/accounts/{account}/webhooks/{webhook}

Rename, pause or activate a webhook after receiver setup

Operation ID: webhooks.update
Required scope: webhooks:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/webhooks

List company webhook endpoints without signing keys

Operation ID: webhooks.index
Required scope: webhooks:read
Action type: Read

POST/api/v1/accounts/{account}/webhooks

Create a paused webhook bound to a company automation

Operation ID: webhooks.create
Required scope: webhooks:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/admin/workspace/dns-hub-agreements/{agreement}/renew

Renew the same operator hub agreement without changing its source

Operation ID: workspace.dns-hub-agreements.renew
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/dns-hub-agreements/{agreement}/revoke

Stop future writes through the original platform hub agreement

Operation ID: workspace.dns-hub-agreements.revoke
Required scope: admin:write
Action type: admin

GET/api/v1/accounts/{account}/admin/workspace/dns-hub-agreements

Inspect the exact configured SPF/DMARC platform zone and operator agreements

Operation ID: workspace.dns-hub-agreements.list
Required scope: admin:read
Action type: admin

POST/api/v1/accounts/{account}/admin/workspace/dns-hub-agreements

Approve finite DNS-only maintenance of the actual platform hub

Operation ID: workspace.dns-hub-agreements.create
Required scope: admin:write
Action type: admin

POST/api/v1/accounts/{account}/credential-claims/{secret}/consume

Consume credentials once without durable plaintext output

Operation ID: workspace.credentials.consume
Required scope: workspace.credentials:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/workspaces/{workspace}/actions/book-theme

Configure Book colors

Operation ID: workspace.book-theme.set
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/actions/book

Configure Book

Operation ID: workspace.book.set
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/actions/conserio-retention-included

Return to included retention with explicit shorter-retention approval

Operation ID: workspace.retention.included
Required scope: workspace:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/workspaces/{workspace}/actions/conserio

Enable or disable Conserio

Operation ID: workspace.conserio.set
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/actions/drive-resync

Queue Drive synchronization

Operation ID: workspace.drive-resync
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/actions/meet

Enable or disable Meet

Operation ID: workspace.meet.set
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/actions/resync

Queue Workspace synchronization

Operation ID: workspace.resync
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/actions/service-cancel

Cancel a company Drive service

Operation ID: workspace.services.cancel
Required scope: workspace:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/workspaces/{workspace}/aliases/{alias}/actions/primary

Make an alias the primary address

Operation ID: workspace.aliases.primary
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/aliases/{alias}/actions/remove

Remove an alias

Operation ID: workspace.aliases.remove
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/aliases/{alias}

Read an alias and version

Operation ID: workspace.aliases.get
Required scope: workspace.mailboxes:read
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/aliases

Read Workspace aliases

Operation ID: workspace.aliases.list
Required scope: workspace.mailboxes:read
Action type: Standard action

DELETE/api/v1/accounts/{account}/workspaces/{workspace}/book/images/{which}

Remove a Book image and synchronize Book

Operation ID: workspace.book-images.delete
Required scope: workspace:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/book/images/{which}

Download a stored Book image

Operation ID: workspace.book-images.get
Required scope: workspace:read
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/book/images/{which}

Upload a validated Book image and synchronize Book

Operation ID: workspace.book-images.put
Required scope: workspace:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/book/slug-availability

Check a Book name using the portal directory

Operation ID: workspace.book-slug.check
Required scope: workspace:read
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/book/theme

Read Book colors and image availability

Operation ID: workspace.book-theme.get
Required scope: workspace:read
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/demo-mailbox-intents/{intent}/actions/reconcile

Read back original mail and finish unattempted child-service steps; never resend uncertain effects

Operation ID: workspace.demo-mailboxes.reconcile
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/demo-mailbox-intents/{intent}

Read the original safe demo-mailbox receipt without provider requests

Operation ID: workspace.demo-mailboxes.intent.get
Required scope: workspace.mailboxes:read
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/demo-mailboxes

Create a bounded free ordinary mailbox in an active demo

Operation ID: workspace.demo-mailboxes.create
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/demo-shared-mailboxes

Create a bounded free shared mailbox in an active demo

Operation ID: workspace.demo-shared-mailboxes.create
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}/actions/apply-dns

Publish Workspace DNS for an owned zone

Operation ID: workspace.domains.apply-dns
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}/actions/catch-all

Configure catch-all delivery

Operation ID: workspace.domains.catch-all
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}/actions/primary

Set the primary Workspace domain

Operation ID: workspace.domains.primary
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}/actions/recheck

Recheck domain ownership and configuration

Operation ID: workspace.domains.recheck
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}/actions/switch-mx

Switch a verified domain to Workspace mail

Operation ID: workspace.domains.switch-mx
Required scope: workspace:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}/dns-export

Export required DNS records including ownership verification

Operation ID: workspace.domains.dns-export
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}/dns-service-agreements/{agreement}/renew

Renew the same original finite DNS purpose and explicitly selected held task

Operation ID: workspace.dns-agreements.renew
Required scope: workspace:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}/dns-service-agreements/{agreement}/repair-receipt

Repair only the original HTTP receipt using signed original task evidence

Operation ID: workspace.dns-agreements.repair-receipt
Required scope: workspace:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}/dns-service-agreements/{agreement}/revoke

Stop future automatic DNS without undoing previous effects

Operation ID: workspace.dns-agreements.revoke
Required scope: workspace:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}/dns-service-agreements

Inspect finite DNS-only service approvals and current review versions

Operation ID: workspace.dns-agreements.list
Required scope: workspace:read
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}/dns-service-agreements

Explicitly approve finite automatic Workspace DNS

Operation ID: workspace.dns-agreements.create
Required scope: workspace:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}/dns-status

Refresh DNS status through the portal DNS service

Operation ID: workspace.domains.dns-status
Required scope: workspace:read
Action type: Standard action

DELETE/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}

Remove an unused Workspace domain

Operation ID: workspace.domains.delete
Required scope: workspace:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/workspaces/{workspace}/domains/{domain}

Read a Workspace domain and version

Operation ID: workspace.domains.get
Required scope: workspace:read
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/domains

Read Workspace domains

Operation ID: workspace.domains.list
Required scope: workspace:read
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/domains

Add a domain requiring verification

Operation ID: workspace.domains.create
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/actions/address

Apply account action address

Operation ID: workspace.mailboxes.address
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/actions/block

Apply account action block

Operation ID: workspace.mailboxes.block
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/actions/cancel

Apply account action cancel

Operation ID: workspace.mailboxes.cancel
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/actions/conserio-admin

Set an account Conserio role

Operation ID: workspace.conserio-admin
Required scope: workspace:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/actions/drive-cancel

Apply account action drive-cancel

Operation ID: workspace.mailboxes.drive-cancel
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/actions/drive-enable

Apply account action drive-enable

Operation ID: workspace.mailboxes.drive-enable
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/actions/drive-purge

Permanently purge the exact approved personal Drive contents

Operation ID: workspace.drive-purge
Required scope: workspace.mailboxes:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/actions/drive-resume

Apply account action drive-resume

Operation ID: workspace.mailboxes.drive-resume
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/actions/password-reset

Reset credentials and create a short lived one-time claim

Operation ID: workspace.credentials.reset
Required scope: workspace.credentials:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/actions/password-reveal

Create a short lived one-time credential claim

Operation ID: workspace.credentials.reveal
Required scope: workspace.credentials:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/actions/resume

Apply account action resume

Operation ID: workspace.mailboxes.resume
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/actions/system-mailbox

Apply account action system-mailbox

Operation ID: workspace.mailboxes.system-mailbox
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/actions/unblock

Apply account action unblock

Operation ID: workspace.mailboxes.unblock
Required scope: workspace.mailboxes:write
Action type: Standard action

DELETE/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/aliases/{alias}

Delete an owned alias

Operation ID: workspace.aliases.delete
Required scope: workspace.mailboxes:write
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/aliases

Add an email alias

Operation ID: workspace.aliases.create
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/conserio-status

Read account conserio-status through the portal service

Operation ID: workspace.mailboxes.conserio-status
Required scope: workspace.mailboxes:read
Action type: Standard action

DELETE/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/delegates/{delegate}

Remove one colleague mail/calendar access without changing other delegates

Operation ID: workspace.delegates.remove
Required scope: workspace.mailboxes:write
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/delegates/{delegate}

Set one colleague mail/calendar access; enabling Send As requires recent personal verification

Operation ID: workspace.delegates.set
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/delegates

Read managed and observed mailbox/calendar access

Operation ID: workspace.delegates.list
Required scope: workspace.mailboxes:read
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/delegations

Read the visible personal mailboxes this colleague may access

Operation ID: workspace.delegates.access
Required scope: workspace.mailboxes:read
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/drive-contents

Read account drive-contents through the portal service

Operation ID: workspace.mailboxes.drive-contents
Required scope: workspace.mailboxes:read
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/drive-purge/{intent}/actions/recover

Explicitly recover the same sealed original Drive intent and HTTP receipt without allocating a new request

Operation ID: workspace.drive-purge.recover
Required scope: workspace.mailboxes:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/drive-purge

Inspect the existing personal Drive cancellation or permanent purge without a supplier call

Operation ID: workspace.drive-purge.get
Required scope: workspace.mailboxes:read
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/profile

Read or replace scoped Workspace mailbox profile data without billing

Operation ID: workspace.profiles.mailbox.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/profile

Read or replace scoped Workspace mailbox profile data without billing

Operation ID: workspace.profiles.mailbox.put
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/settings

Read mail client settings without passwords

Operation ID: workspace.mailboxes.settings
Required scope: workspace.mailboxes:read
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/setup/pdf-claim

Create a one-time setup PDF claim including the password

Operation ID: workspace.setup.pdf-claim
Required scope: workspace.credentials:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/setup/pdf

Download the portal setup PDF without a password

Operation ID: workspace.setup.pdf
Required scope: workspace.mailboxes:read
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/setup/send-with-password

Explicitly share setup instructions and password by email

Operation ID: workspace.setup.send-with-password
Required scope: workspace.credentials:read
Action type: Sensitive action requiring extra verification

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/setup/send

Email the portal setup instructions and PDF without a password

Operation ID: workspace.setup.send
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/shared-mailboxes

Read the shared mailboxes accessible to one colleague

Operation ID: workspace.mailboxes.shared-mailboxes.list
Required scope: workspace.mailboxes:read
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}/team-folders

Read account team-folders through the portal service

Operation ID: workspace.mailboxes.team-folders
Required scope: workspace.mailboxes:read
Action type: Standard action

DELETE/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}

Delete an account and its data

Operation ID: workspace.mailboxes.delete
Required scope: workspace.mailboxes:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}

Read a Workspace account

Operation ID: workspace.mailboxes.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PATCH/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes/{mailbox}

Change an account display name

Operation ID: workspace.mailboxes.update
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailboxes

List Workspace accounts

Operation ID: workspace.mailboxes.list
Required scope: workspace.mailboxes:read
Action type: Standard action

DELETE/api/v1/accounts/{account}/workspaces/{workspace}/mailing-lists/{list}/members/{member}

Remove only this member

Operation ID: workspace.lists.members.remove
Required scope: workspace.mailboxes:write
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/mailing-lists/{list}/members/{member}

Add one current company member

Operation ID: workspace.lists.members.add
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailing-lists/{list}/members

Read visible members

Operation ID: workspace.lists.members.list
Required scope: workspace.mailboxes:read
Action type: Standard action

DELETE/api/v1/accounts/{account}/workspaces/{workspace}/mailing-lists/{list}

Delete free Workspace lists

Operation ID: workspace.lists.delete
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailing-lists/{list}

Get free Workspace lists

Operation ID: workspace.lists.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PATCH/api/v1/accounts/{account}/workspaces/{workspace}/mailing-lists/{list}

Update free Workspace lists

Operation ID: workspace.lists.update
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/mailing-lists

List free Workspace lists

Operation ID: workspace.lists.list
Required scope: workspace.mailboxes:read
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/mailing-lists

Create free Workspace lists

Operation ID: workspace.lists.create
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/orders/{invoice}/cancel

Cancel every held delivery on the original unpaid Workspace invoice

Operation ID: workspace.orders.cancel
Required scope: workspace:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/workspaces/{workspace}/orders/{invoice}/cancellation

Inspect the whole unpaid Workspace order and its saved cancellation

Operation ID: workspace.orders.cancellation.get
Required scope: workspace:read
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/portal-approvals/{intent}/reapprove

Explicitly renew the same original browser maintenance tasks

Operation ID: workspace.portal-approvals.reapprove
Required scope: workspace:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/workspaces/{workspace}/portal-approvals/{intent}

Inspect original browser maintenance without supplier requests

Operation ID: workspace.portal-approvals.get
Required scope: workspace:read
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/workspaces/{workspace}/profile-settings

Read or replace scoped Workspace settings profile data without billing

Operation ID: workspace.profiles.settings.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/profile-settings

Read or replace scoped Workspace settings profile data without billing

Operation ID: workspace.profiles.settings.put
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/profiles/bulk

Review or atomically update scoped Workspace profile data

Operation ID: workspace.profiles.bulk
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/profiles/export

Review or atomically update scoped Workspace profile data

Operation ID: workspace.profiles.csv.export
Required scope: workspace.mailboxes:read
Action type: Read

POST/api/v1/accounts/{account}/workspaces/{workspace}/profiles/import/preview

Review or atomically update scoped Workspace profile data

Operation ID: workspace.profiles.csv.preview
Required scope: workspace.mailboxes:write
Action type: Read

POST/api/v1/accounts/{account}/workspaces/{workspace}/profiles/import

Review or atomically update scoped Workspace profile data

Operation ID: workspace.profiles.csv.import
Required scope: workspace.mailboxes:write
Action type: Standard action

DELETE/api/v1/accounts/{account}/workspaces/{workspace}/rooms/{room}/managers/{mailbox}

Remove only this mailbox

Operation ID: workspace.rooms.managers.remove
Required scope: workspace.mailboxes:write
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/rooms/{room}/managers/{mailbox}

Add one current company mailbox

Operation ID: workspace.rooms.managers.add
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/rooms/{room}/managers

Read visible managers

Operation ID: workspace.rooms.managers.list
Required scope: workspace.mailboxes:read
Action type: Standard action

DELETE/api/v1/accounts/{account}/workspaces/{workspace}/rooms/{room}

Delete free Workspace rooms

Operation ID: workspace.rooms.delete
Required scope: workspace.mailboxes:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/workspaces/{workspace}/rooms/{room}

Get free Workspace rooms

Operation ID: workspace.rooms.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PATCH/api/v1/accounts/{account}/workspaces/{workspace}/rooms/{room}

Update free Workspace rooms

Operation ID: workspace.rooms.update
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/rooms

List free Workspace rooms

Operation ID: workspace.rooms.list
Required scope: workspace.mailboxes:read
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/rooms

Create free Workspace rooms

Operation ID: workspace.rooms.create
Required scope: workspace.mailboxes:write
Action type: Standard action

DELETE/api/v1/accounts/{account}/workspaces/{workspace}/shared-mailboxes/{shared}/members/{mailbox}

Remove one colleague from this shared mailbox only

Operation ID: workspace.shared-mailboxes.members.remove
Required scope: workspace.mailboxes:write
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/shared-mailboxes/{shared}/members/{mailbox}

Grant one colleague full shared mailbox access without changing other memberships

Operation ID: workspace.shared-mailboxes.members.add
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/shared-mailboxes/{shared}/members

Read visible colleagues with shared mailbox access, including Send As

Operation ID: workspace.shared-mailboxes.members.list
Required scope: workspace.mailboxes:read
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/shared-mailboxes/{shared}/profile

Read or replace scoped Workspace shared-mailbox profile data without billing

Operation ID: workspace.profiles.shared-mailbox.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/shared-mailboxes/{shared}/profile

Read or replace scoped Workspace shared-mailbox profile data without billing

Operation ID: workspace.profiles.shared-mailbox.put
Required scope: workspace.mailboxes:write
Action type: Standard action

DELETE/api/v1/accounts/{account}/workspaces/{workspace}/shared-mailboxes/{shared}

Permanently delete a shared mailbox and its mail after address confirmation

Operation ID: workspace.shared-mailboxes.delete
Required scope: workspace.mailboxes:write
Action type: Sensitive action requiring extra verification

GET/api/v1/accounts/{account}/workspaces/{workspace}/shared-mailboxes/{shared}

Read a shared mailbox without provider IDs or credentials

Operation ID: workspace.shared-mailboxes.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PATCH/api/v1/accounts/{account}/workspaces/{workspace}/shared-mailboxes/{shared}

Replace a shared mailbox name or complete alias set

Operation ID: workspace.shared-mailboxes.update
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/shared-mailboxes

List shared mailboxes and their current versions

Operation ID: workspace.shared-mailboxes.list
Required scope: workspace.mailboxes:read
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/shared-mailboxes

Order a paid shared mailbox using a reviewed normal mail package

Operation ID: workspace.shared-mailboxes.create
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/signatures/banner

MailSig banner

Operation ID: workspace.signatures.banner.post
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/signatures/campaigns

Read MailSig campaigns and its current version

Operation ID: workspace.signatures.campaigns.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/signatures/campaigns

Replace MailSig campaigns without billing

Operation ID: workspace.signatures.campaigns.put
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/signatures/company

Read MailSig company and its current version

Operation ID: workspace.signatures.company.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/signatures/company

Replace MailSig company without billing

Operation ID: workspace.signatures.company.put
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/signatures/gallery/{design}/import

Import a gallery template or apply a full/reply variant as in the portal

Operation ID: workspace.signatures.gallery.import
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/signatures/gallery

Read MailSig gallery

Operation ID: workspace.signatures.gallery.get
Required scope: workspace.mailboxes:read
Action type: Standard action

DELETE/api/v1/accounts/{account}/workspaces/{workspace}/signatures/images/{image}

Delete only this workspace signature image; photos are removed immediately

Operation ID: workspace.signatures.images.delete
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/signatures/images

Read MailSig images

Operation ID: workspace.signatures.images.get
Required scope: workspace.mailboxes:read
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/signatures/images

MailSig images

Operation ID: workspace.signatures.images.post
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/signatures/onboarding

Read MailSig onboarding and its current version

Operation ID: workspace.signatures.onboarding.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/signatures/onboarding

Replace MailSig onboarding without billing

Operation ID: workspace.signatures.onboarding.put
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/signatures/preview

MailSig preview

Operation ID: workspace.signatures.preview.post
Required scope: workspace.mailboxes:read
Action type: Read

GET/api/v1/accounts/{account}/workspaces/{workspace}/signatures/rules

Read MailSig rules and its current version

Operation ID: workspace.signatures.rules.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/signatures/rules

Replace MailSig rules without billing

Operation ID: workspace.signatures.rules.put
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/signatures/settings

Read MailSig settings and its current version

Operation ID: workspace.signatures.settings.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/signatures/settings

Replace MailSig settings without billing

Operation ID: workspace.signatures.settings.put
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/signatures/status

Read MailSig status

Operation ID: workspace.signatures.status.get
Required scope: workspace.mailboxes:read
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/signatures/templates

Read MailSig templates and its current version

Operation ID: workspace.signatures.templates.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/signatures/templates

Replace MailSig templates without billing

Operation ID: workspace.signatures.templates.put
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/signatures/testmail

MailSig testmail

Operation ID: workspace.signatures.testmail.post
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/signatures/validate

MailSig validate

Operation ID: workspace.signatures.validate.post
Required scope: workspace.mailboxes:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/signatures/variables

Read MailSig variables

Operation ID: workspace.signatures.variables.get
Required scope: workspace.mailboxes:read
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/signatures/variants

Read MailSig variants and its current version

Operation ID: workspace.signatures.variants.get
Required scope: workspace.mailboxes:read
Action type: Standard action

PUT/api/v1/accounts/{account}/workspaces/{workspace}/signatures/variants

Replace MailSig variants without billing

Operation ID: workspace.signatures.variants.put
Required scope: workspace.mailboxes:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/team-folders/{space}/actions/archive

Apply team folder action archive

Operation ID: workspace.team-folders.archive
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/team-folders/{space}/actions/owner

Apply team folder action owner

Operation ID: workspace.team-folders.owner
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/team-folders/{space}/actions/remove-member

Apply team folder action remove-member

Operation ID: workspace.team-folders.remove-member
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/team-folders/{space}/actions/rename

Apply team folder action rename

Operation ID: workspace.team-folders.rename
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/team-folders/{space}/actions/set-member

Apply team folder action set-member

Operation ID: workspace.team-folders.set-member
Required scope: workspace:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/team-folders/{space}

Read a team folder and current membership version

Operation ID: workspace.team-folders.get
Required scope: workspace:read
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/team-folders

List team folders without fetching every membership

Operation ID: workspace.team-folders.list
Required scope: workspace:read
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces/{workspace}/team-folders

Create a team folder with Workspace mailbox permissions

Operation ID: workspace.team-folders.create
Required scope: workspace:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{workspace}/usage

Read measured Drive usage

Operation ID: workspace.usage.get
Required scope: workspace:read
Action type: Standard action

DELETE/api/v1/accounts/{account}/workspaces/{workspace}

Delete an empty Workspace with recent strong authentication

Operation ID: workspace.delete
Required scope: workspace:write
Action type: Sensitive action requiring extra verification

PATCH/api/v1/accounts/{account}/workspaces/{workspace}

Rename a Workspace

Operation ID: workspace.update
Required scope: workspace:write
Action type: Standard action

POST/api/v1/accounts/{account}/workspaces

Create a company Workspace and verification domain

Operation ID: workspace.create
Required scope: workspace:write
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces/{id}

Get workspaces

Operation ID: workspaces.get
Required scope: workspace:read
Action type: Standard action

GET/api/v1/accounts/{account}/workspaces

List workspaces

Operation ID: workspaces.list
Required scope: workspace:read
Action type: Standard action