tenant210 ops

Tenant API

Tenant configuration, branding, regional settings, and onboarding state.

Queries

QUERY

adminAddonBreakdown

#

Add-on usage breakdown (PlatformAdmin only).

Returns[!]!
QUERY

adminAttention

#

What needs the platform owner's attention today: trials about to end unpaid, subscriptions past due and sign-ups that stalled (PlatformAdmin only).

Returns!
QUERY

adminBillingEvents

#

List billing events for a tenant (PlatformAdmin only). sort orders the whole list before it is paged; omitted, newest first.

Arguments

  • tenantId!
  • pagination
  • sort
Returns!
QUERY

adminFleetOrders

#

Orders across every customer workspace in the period, and how many workspaces took any, against the previous period (PlatformAdmin only). Read from the daily order rollup, which holds whole UTC days and trails live orders by a couple of minutes: a window is the days it covers, the first whole day to the one still in progress. "Today" has no day to compare with at that grain, so it alone is counted from the orders themselves, hour by hour. Fails rather than answering zero when the rollup cannot be read.

Arguments

  • period!

    Default

    "LAST30_DAYS"
Returns!
QUERY

adminGetTenant

#

Get a single tenant by ID (PlatformAdmin only).

Arguments

  • id!
Returns
QUERY

adminListCountryExclusivities

#

List all active country exclusivity agreements. PlatformAdmin only. sort orders the whole list before it is paged; omitted, newest first.

Arguments

  • pagination!

    Default

    {
      "limit": 10,
      "page": 1,
      "after": null
    }
  • sort
Returns!
QUERY

adminListPlatformNotificationChannels

#

List every configured channel. PlatformAdmin only.

Returns[!]!
QUERY

adminListRegionExclusivities

#

List all active region (city) exclusivity agreements. PlatformAdmin only. sort orders the whole list before it is paged; omitted, newest first.

Arguments

  • pagination!

    Default

    {
      "limit": 10,
      "page": 1,
      "after": null
    }
  • sort
Returns!
QUERY

adminListRegistrations

#

List tenant registrations with optional status, search and creation-date filters (PlatformAdmin only).

Arguments

  • input!

    Default

    {
      "status": null,
      "search": null,
      "createdFrom": null,
      "createdTo": null,
      "sort": null,
      "pagination": {
        "limit": 10,
        "page": 1,
        "after": null
      }
    }
Returns!
QUERY

adminListTenants

#

List tenants with optional search, status, plan and creation-date filters (PlatformAdmin only).

Arguments

  • input!

    Default

    {
      "search": null,
      "status": null,
      "statuses": null,
      "planIds": null,
      "createdFrom": null,
      "createdTo": null,
      "ids": null,
      "sort": null,
      "pagination": {
        "limit": 10,
        "page": 1,
        "after": null
      }
    }
Returns!
QUERY

adminPendingTenantDataWipe

#

Active (PENDING or EXECUTING) wipe for the given tenant, if any. Powers the "pending wipe banner" on the tenant detail page. PlatformAdmin only.

Arguments

  • tenantId!
Returns
QUERY

adminPlatformNotificationEventKinds

#

Enumerate every event kind the platform can fire — the UI uses this to populate the subscription checkbox list so new events appear automatically after a migration.

Returns[!]!
QUERY

adminPlatformPulse

#

The period's headline figures — sign-ups, workspaces created, newly paying workspaces and money collected — each with its change on the previous period and a sparkline (PlatformAdmin only). A figure and the one it is compared with are totals over the two exact windows. The sparkline is the current window in whole UTC buckets: hours for today, months for the year, days otherwise.

Arguments

  • period!

    Default

    "LAST30_DAYS"
Returns!
QUERY

adminPlatformUsage

#

Overall platform usage metrics (PlatformAdmin only).

Returns!
QUERY

adminRevenueMetrics

#

Platform-wide revenue metrics (PlatformAdmin only).

Returns!
QUERY

adminSignupAcquisition

#

Where the sign-ups started in the period came from — paid traffic against organic, bucketed for charting, with how far each kind has got by now and the channels behind it (PlatformAdmin only). The cohort is the one adminSignupFunnel counts. Buckets are UTC — hours for today, months for the year, days otherwise.

Arguments

  • period!

    Default

    "LAST30_DAYS"
Returns!
QUERY

adminSignupFunnel

#

How far the sign-ups started in the period have got by now: email verified, workspace created, first order, card added, paying (PlatformAdmin only).

Arguments

  • period!

    Default

    "LAST30_DAYS"
Returns!
QUERY

adminStoreCredentials

#

Configured store credentials — redacted metadata only, never key material.

Returns[!]!
QUERY

adminStoreReleaseOverview

#

Store release status of every platform connected app: live / in-review / beta versions per store, compared against the latest code version released through the Release Hub.

Returns!
QUERY

adminSubscriptions

#

List all subscriptions (PlatformAdmin only).

Arguments

  • status
  • pagination
Returns!
QUERY

adminSubscriptionsByPlan

#

Subscription breakdown by plan (PlatformAdmin only).

Returns[!]!
QUERY

adminSubscriptionsByStatus

#

Subscription breakdown by status (PlatformAdmin only).

Returns[!]!
QUERY

adminTenantActivity

#

Operational activity snapshot for a specific tenant (PlatformAdmin only). Returns total account counts broken down by role, total order counts broken down by kind and lifecycle status, and a 30-day daily series of new accounts + orders so the admin console can visualize how an individual tenant is tracking through its setup.

Arguments

  • tenantId!
Returns!
QUERY

adminTenantBranding

#

Get the current branding configuration for a specific tenant (PlatformAdmin only).

Arguments

  • tenantId!
Returns
QUERY

adminTenantDataWipes

#

Most recent wipe requests across all tenants. Powers the dashboard "pending wipes" panel and the audit lookup page. PlatformAdmin only.

Arguments

  • limitInt!

    Default

    50
Returns[!]!
QUERY

adminTenantEngagement

#

Active workspaces by how much they are being used, and the same for the ones still on trial (PlatformAdmin only).

Returns!
QUERY

adminTenantJourney

#

Tenant journey from existing histories and setup records. PlatformAdmin only; filtering happens before global pagination. No credential payloads.

Arguments

  • tenantId!
  • source
  • pagination
Returns!
QUERY

adminTenantOperationCityList

#

Full operation-city allow-list for a tenant — active and disabled rows — for the platform-admin tenant detail UI (PlatformAdmin only). Mirrors the tenant-side myOperationCityList so support staff see the same picture the tenant sees, including cities that were auto-shrunk on a plan downgrade.

Arguments

  • tenantId!
Returns[!]!
QUERY

adminTenantPlatformAddons

#

Admin view of any tenant's platform addons. Includes audit fields (granted_by, granted_at, note) and revoked-but-retained rows (enabled = false). PlatformAdmin only.

Arguments

  • tenantId!
Returns[!]!
QUERY

adminTenantRegistrationSeries

#

Tenant sign-ups over a named window, bucketed and split by the product each one chose, for the dashboard chart (PlatformAdmin only). Buckets are UTC — hours for today, months for the year, days otherwise — and only whole buckets inside the window are returned, so each bar counts the full bucket it is labelled with; the last one is still in progress. Sign-ups that became a demo tenant are left out, like everywhere else on the admin dashboard.

Arguments

  • period!

    Default

    "LAST30_DAYS"
Returns!
QUERY

adminTenantsListSignals

#

Country and order signals for a page of the tenant list (PlatformAdmin only). One entry per requested tenant, in no particular order; tenants that don't exist are simply absent.

Arguments

  • tenantIds[!]!
Returns[!]!
QUERY

adminTenantStats

#

Quick dashboard aggregation of tenant and registration counts (PlatformAdmin only).

Returns!
QUERY

adminTenantSubscription

#

Get a specific tenant's subscription (PlatformAdmin only).

Arguments

  • tenantId!
Returns
QUERY

adminTenantWallet

#

Read any tenant's plan-credit wallet (PlatformAdmin only).

Arguments

  • tenantId!
  • currencyString!
Returns!
QUERY

adminTenantWalletEntries

#

Recent ledger entries for a tenant wallet, newest first (PlatformAdmin only). Capped at limit (default 50, max 200).

Arguments

  • tenantId!
  • currencyString!
  • limitInt
Returns[!]!
QUERY

adminTopTenants

#

Top tenants by transaction volume (PlatformAdmin only).

Arguments

  • limitInt!

    Default

    10
Returns[!]!
QUERY

adminTrialConversion

#

Trial-to-paid conversion metrics (PlatformAdmin only).

Returns!
QUERY

adminVerticalDistribution

#

Distribution of tenants across verticals (PlatformAdmin only).

Returns[!]!
QUERY

apiKeyAuditLog

#

Get the audit log for API key events. Can filter by specific API key ID or get all events for the tenant. Requires TenantAdmin role.

Arguments

  • input!
Returns!
QUERY

apiKeys

#

List all API keys for the current tenant. By default, only active (non-revoked) keys are returned. Set includeRevoked to true to include revoked keys. Requires TenantAdmin role.

Arguments

  • includeRevokedBoolean!

    Default

    false
Returns[!]!
QUERY

availablePlans

#

Browse available plans (public, no auth required). currency is resolved server-side against the config's supported set, falling back to the caller's own base currency and then to the default rather than erroring — this is what the public pricing page reads, and a blank page is a worse answer than a dollar price. Each returned price carries its own currency, so a fallback is visible to the caller without a separate flag. The base-currency step only fires for an authenticated caller; the marketing and onboarding pages fetch this with the public API key and pass currency explicitly, which is also what keeps their shared fetch cache keyed per currency. include_retired adds plans that are no longer sold but still back live subscriptions. Off by default so the pricing page is unaffected; it exists for tooling that validates references to plan ids, which would otherwise see a grandfathered plan as a dangling id.

Arguments

  • currency
  • includeRetiredBoolean!

    Default

    false
Returns[!]!
QUERY

brandCatalog

#

Styles, marks and preset colours available to brand generation.

Returns!
QUERY

branding

#

Get the current branding configuration. Returns the active branding for the current tenant.

Returns
QUERY

brandingRevisions

#

Get all branding configuration revisions. Returns the history of branding changes for this tenant.

Returns[!]!
QUERY

brandingVersion

#

Get branding configuration by version. Useful for previewing or rolling back to a previous version.

Arguments

  • versionInt!
Returns
QUERY

brandPreview

#

Compose the marks the given inputs would generate. Takes the same input as generateBranding and stores nothing, so the studio can show a brand before an operator commits to it — and shows the composer's own output rather than an approximation of it. Guarded like the mutation: the inputs can name the tenant's uploaded logo, so this reads tenant-owned bytes even though it writes nothing.

Arguments

  • input!
Returns!
QUERY

cardlessAllowedPlans

#

Plan ids that may be started cardless (a 14-day trial with no card up front). Every plan not listed requires a card via Stripe checkout.

Returns[String!]!
QUERY

checkSlugChange

#

Whether the caller's workspace could change its slug to newSlug right now, and the addresses it would get. The same decision changeTenantSlug makes — the slug rule, the 30-day cooldown, and whether the slug is free — without changing anything, so the console can answer while the owner types. A slug the workspace itself used to have is AVAILABLE: it is reserved for exactly that. Owner only.

Arguments

  • newSlugString!
Returns!
QUERY

citiesByCountry

#

List all cities in a country (for admin dropdowns).

Arguments

  • countryCodeString!
Returns[!]!
QUERY

clientBootstrap

#

One-shot tenant bootstrap. Returns the tenant identity + every client-facing config slice in a single round-trip. Read by the client SDK at app startup; per-domain queries (branding, mapProviderConfig, …) stay available for admin tools. **The client selects everything; this decides what to answer.** A vertical's own slice goes only to that vertical's apps — a shop client gets no taxi operations, and the config is not even parsed for it. The alternative is each app maintaining its own field selection, which is how seven copies of one query drifted into seven different shapes.

Returns!
QUERY

currentTenantStoreReviewer

#

The tenant's auto-provisioned store-review account. Returns null if the reviewer hasn't been provisioned yet — the frontend should surface a "Provision" CTA in that case.

Returns
QUERY

customDomainSettings

#

How a custom domain is set up on this deployment — what the "add a domain" form tells the tenant to do before they have added one.

Returns!
QUERY

discoverTenantByCode

#

Discover a tenant by its join code or its slug (public, no auth required). Both are case-insensitive. A join code (at most 5 characters) wins; otherwise the input is matched against tenant slugs, so "acme-rides" finds the tenant served at acme-rides.bettersuite.io. A slug the tenant has since changed away from still finds it — printed material outlives a slug. Returns null if no active, discoverable tenant matches.

Arguments

  • codeString!
Returns
QUERY

discoverTenantByDomain

#

Discover a tenant by its domain (public, no auth required). Resolves the tenant from a custom or system domain string (e.g., "acme-rides.bettersuite.io" or "ride.acmetaxi.com"). Returns null if no active tenant matches the domain.

Arguments

  • domainString!
Returns
QUERY

discoverTenantsNearby

#

Discover tenants near a geographic location (public, no auth required). Searches via operation cities within the given radius, ordered by distance to the nearest city.

Arguments

  • input!
Returns[!]!
QUERY

exclusivityPriceForCities

#

Get exclusivity pricing for specific cities. Returns per-city pricing based on population, along with availability (whether the city is already locked by another tenant). Call this after the tenant has selected their operation cities.

Arguments

  • cityIds[!]!
  • currency
  • registrationIdString

    Registration id, for the sign-up wizard's pre-tenant plan step. Ignored when the request is authenticated.

Returns[!]!
QUERY

exclusivityPriceForCountries

#

Get exclusivity pricing for specific countries.

Arguments

  • countryCodes[String!]!
  • currency
  • registrationIdString

    Registration id, for the sign-up wizard's pre-tenant plan step. Ignored when the request is authenticated.

Returns[!]!
QUERY

isSlugAvailable

#

Check if a slug is free to sign up with: no workspace has it, and none has it reserved as a slug it used to have.

Arguments

  • slugString!
ReturnsBoolean!
QUERY

meTenant

#

Get the current tenant (based on JWT token)

Returns
QUERY

myAddons

#

Get the active add-ons of the current tenant's active subscription. Scoped to that subscription rather than to the tenant. Putting a cardless trial on a card creates a new subscription and re-provisions its add-ons onto it, while the rows on the trial it replaces stay active — so a tenant-wide read listed every converted add-on twice.

Returns[!]!
QUERY

myBlogCategories

Deprecated#

The workspace's categories by name, with how many posts each has.

Deprecation reason: Use myBlogCategoryList; BET-205

Returns[!]!
QUERY

myBlogCategoryList

#
Returns[!]!
QUERY

myBlogPost

#

One post of the workspace, or null.

Arguments

  • idID!
Returns
QUERY

myBlogPosts

#

The workspace's blog posts, most recently changed first, optionally of one status. For admins and the owner.

Arguments

  • status
  • pagination
Returns!
QUERY

myDomains

#

List all domains (system + custom) for the current tenant.

Returns[!]!
QUERY

myInvoices

#

Get the current tenant's invoice history (upcoming and past). sort orders the whole history before it is paged; omitted, the most recent invoice comes first. A staff seat needs View billing.

Arguments

  • pagination
  • sort
Returns!
QUERY

myOperationCities

Deprecated#

Deployed web clients still use this projection; retire through BET-204.

Deprecation reason: Use myOperationCityList(status: ACTIVE); retirement tracked in BET-204

Returns[!]!
QUERY

myOperationCityList

#

Full allow-list: active and disabled rows. Disabled rows stay in the list with their status/disabledReason so the UI can show reactivate affordances without rediscovering cities.

Arguments

  • status
Returns[!]!
QUERY

myOperationFootprint

#

Aggregated footprint of where the tenant operates: distinct countries, admin regions, and cities, joined with the shared geo reference tables. One round trip for cascading dropdowns (tax zone editor, region setup, dashboard summaries) so each surface doesn't re-derive the dedupe / join logic.

Returns!
QUERY

mySite

#

The calling workspace's site, or null when it has not enabled one. For admins and the owner.

Returns
QUERY

mySiteLeads

#

The enquiries sent through the site's contact form, newest first. For admins and the owner.

Arguments

  • unreadOnlyBoolean!

    Default

    false
  • pagination
Returns!
QUERY

mySiteUnreadLeadCount

#

How many enquiries the workspace has not read yet. For the dashboard's badge.

ReturnsInt!
QUERY

mySubscription

#

Get the current tenant's active subscription.

Returns
QUERY

myUsage

#

Get the current tenant's usage meters. Event-counter meters (e.g. monthly_transactions) come from the usage-meter store, written by record_usage. State counters (verticals, locations) are synthesized here from their authoritative sources — the active subscription and the operation-area repo — so they can't drift from reality.

Returns[!]!
QUERY

pendingRegistration

#

The sign-up this browser is onboarding, read from its registration cookie; null when there is none, or it can no longer be resumed. Web consoles only (cookie session transport). No authentication: the registration cookie is the credential, exactly as for updateOnboardingBusiness and createRegistrationCheckout.

Returns
QUERY

planAddons

#

Get available add-ons for a plan (public).

Arguments

  • planIdString!
  • currency
Returns[!]!
QUERY

planDetails

#

Get details for a specific plan (public).

Arguments

  • planIdString!
  • currency
Returns
QUERY

planUsageRates

#

Every configured usage rate. PlatformAdmin only — these are the numbers every tenant on a usage plan is billed by.

Returns[!]!
QUERY

platformConnectedApps

#

All platform-owned connected apps (shared by every tenant). Callable by tenant admins too — they need to see what they're inheriting (and opt out of) on the domain-admin UI.

Returns[!]!
QUERY

regionalSettings

#

Get the current regional settings configuration. Returns locale, measurement system, time format, map defaults, wallet top-up presets, and support contact for the current tenant.

Returns
QUERY

searchCities

#

Search reference cities by name prefix (for admin UI dropdowns).

Arguments

  • queryString!
  • countryCodeString
  • limitInt
Returns[!]!
QUERY

siteAppsPreview

#

The workspace's apps as an appLinks block would show them with these settings, so the editor can preview the toggles before saving. For admins and the owner.

Arguments

  • sharedAppsBoolean!

    Default

    false
  • supplyAppsBoolean!

    Default

    false
Returns[!]!
QUERY

siteAreasPreview

#

The workspace's active operation cities as an areas block with source: "operation" would list them now, for the editor. For admins and the owner.

Returns[!]!
QUERY

siteBlogPostBySlug

#

One post of the blog of the site on host, or null (answer 404). With a valid previewToken a draft or scheduled post is returned too, so an operator can read a post before it goes live.

Arguments

  • hostString!
  • slugString!
  • previewTokenString
Returns
QUERY

siteBlogPosts

#

One page (12 posts, newest first) of the blog of the site on host, with the categories a visitor can browse. null: answer 404 (not a site, not published, blog not enabled, or no such page or category). Only published posts dated now or earlier are returned; a draft or scheduled post never is, whatever the token. previewToken is the site's preview token (as for siteByHost): it reads the draft site's blog setting and answers with ttlSeconds: 0. An invalid one fails with PREVIEW_TOKEN_INVALID.

Arguments

  • hostString!
  • pageInt

    Default

    1
  • categorySlugString
  • previewTokenString
Returns
QUERY

siteByHost

#

The site served on host, as the renderer reads it. null: answer 404. * locale — the visitor's language; resolvedLocale is what to show. * previewToken — from createSitePreview. With a valid one the **draft** is returned (isPreview, noindex); with an invalid or expired one the call fails with PREVIEW_TOKEN_INVALID. Without one, only a published site is ever returned. * ifVersion — the version the caller holds; when it is current the answer has notModified: true and no content. When redirectToHost is set, answer 307 to https://<redirectToHost><path> and ignore the rest.

Arguments

  • hostString!
  • localeString
  • previewTokenString
  • ifVersionString
Returns
QUERY

siteFleetPreview

#

The workspace's active ride classes as a fleet block would show them now, so the editor can preview the block, or say why it is empty. For admins and the owner.

Returns[!]!
QUERY

siteTemplates

#

The templates a site can wear, for the picker: each with the business types it is made for (empty: any) and whether it suits this workspace. For admins and the owner.

Returns[!]!
QUERY

supportedLanguages

#

List every language the platform can render end-user UI in. This is the canonical superset a tenant picks its available_languages from. Static platform metadata — no tenant context required.

Returns[!]!
QUERY

tenantAuthPolicy

#

Resolve the tenant's effective AuthPolicy. Never returns null — falls back to the platform default when the tenant has no revision stored.

Returns!
QUERY

tenantConnectedApps

#

Connected apps owned by a tenant. Tenant admins omit tenantId (defaults to their own); platform admins may pass any tenantId.

Arguments

  • tenantIdID
Returns[!]!
QUERY

tenantDisabledPlatformAppIds

#

IDs of platform apps the tenant has opted out of. Tenant admins omit tenantId; platform admins may pass any tenantId.

Arguments

  • tenantIdID
Returns[ID!]!
QUERY

tenantInfo

#

Get public tenant information. Returns tenant info including branding, current plan details, available upgrades, and add-ons. Accessible to all authenticated users within the tenant.

Returns!
QUERY

tenantOnboardingStatus

#

Get the onboarding completion status for the current tenant.

Returns!
QUERY

tenantTesters

#

The tenant's tester accounts (role · phone · deterministic OTP). Empty until the roster is provisioned. Admins get the whole roster. While the workspace has no SMS provider, anyone else — including a signed-out app on its login screen — gets the testers for the app and role it names, so the operator can sign in without a gateway. Once a provider is connected the roster is admin-only again.

Arguments

  • app

    The calling app. Narrows a non-admin caller's roster to its own slot; defaults to the `x-app` header. Ignored for admins.

  • role

    The role the calling app signs in as. Required for a non-admin caller to see any tester — a signed-out request carries no role of its own. Ignored for admins.

Returns[!]!
QUERY

tenantWallet

#

Return the current tenant's plan-credit wallet balance for the given currency. Returns a wallet with exists=false (and zero balances) when the tenant has never been credited — callers should still treat this as a valid empty wallet rather than an error.

Arguments

  • currencyString!
Returns!
QUERY

usageToDate

#

What this month has cost so far, for the signed-in tenant. A metered bill the operator cannot watch accumulate is a support ticket waiting to happen, so this reads the same meters the month-end sweep bills from and applies the same rates. A staff seat needs View billing.

Returns!

Mutations

MUTATION

addCustomDomain

#

Add a custom domain for a tenant app. The domain must be globally unique. After adding, the tenant must set up a CNAME record pointing to the system subdomain (returned in the entity's cname_target field) and then call verifyCustomDomain.

Arguments

  • input!
Returns!
MUTATION

addOperationCity

#

Add a city to the current tenant's operation areas. If the city is already in the allow-list (any status), the row is reactivated rather than re-inserted. Reactivation and net-new adds both consume one slot of the plan's locations limit.

Arguments

  • cityId!
ReturnsBoolean!
MUTATION

addSubscriptionVertical

#

Add a business type to the workspace's subscription, buying an extra slot for it when the subscription has none free. Buying the slot and selecting the business type are one command, so a workspace is never charged for a slot it has not filled. Safe to repeat: a business type already selected returns ALREADY_SELECTED, and a slot an interrupted call paid for is used rather than bought again. Requires Owner-tier (TenantOwner or PlatformAdmin). Every failure carries an extensions.code.

Arguments

  • input!
Returns!
MUTATION

addTenantTester

#

Add a single custom tester for a vertical (customer or provider role), optionally with a specific phone number.

Arguments

  • input!
Returns!
MUTATION

adminActivateTenant

#

Re-activate a suspended or cancelled tenant (PlatformAdmin only). Blocked tenants cannot be activated — use adminUnblockTenant instead.

Arguments

  • id!
Returns!
MUTATION

adminAddOperationCity

#

Add a city to a tenant's operation areas (PlatformAdmin only).

Arguments

  • tenantId!
  • cityId!
ReturnsBoolean!
MUTATION

adminAssignPlan

#

Force-assign a plan to a tenant (PlatformAdmin only, bypasses Stripe).

Arguments

  • tenantId!
  • planIdString!
  • periodDaysInt

    Number of days for the subscription period (None = indefinite).

Returns!
MUTATION

adminBlockTenant

#

Block a tenant immediately (PlatformAdmin only). Blocked tenants cannot be auto-reactivated by billing events. Use adminUnblockTenant to restore access.

Arguments

  • id!
  • reasonString!
Returns!
MUTATION

adminCancelRegistration

#

Cancel a pending registration (PlatformAdmin only).

Arguments

  • idString!
ReturnsBoolean!
MUTATION

adminCancelTenantDataWipe

#

Cancel a pending wipe within the grace window. Any platform admin can cancel any pending wipe — the action is the "safe" direction so no step-up is required.

Arguments

  • id!
Returns!
MUTATION

adminChangeTenantSlug

#

Change a tenant's slug (PlatformAdmin only). The same change an owner makes with changeTenantSlug — system hosts rebuilt on the new slug, the previous slug reserved to the tenant and its hosts redirecting, custom domains left verified — minus the two rules that are the owner's: the 30-day cooldown is waived (the change still restarts it), and a demo workspace may be moved. The system tenant's slug is fixed for everyone. Admin/owner passkeys are unaffected (their WebAuthn RP ID is anchored to the apex, not the subdomain). End-user passkeys bound to a system subdomain will need to be re-registered — those users fall back to OTP. Step-up gated: the platform admin must hold a fresh elevation token, mirroring admin_delete_tenant. Refusals carry the same extensions.code values as changeTenantSlug.

Arguments

  • input!
Returns!
MUTATION

adminCreateCountryExclusivity

#

Create a country exclusivity agreement for a tenant. PlatformAdmin only. If monthly_price_minor is omitted the price is auto-calculated from the country's GDP-based value tier.

Arguments

  • input!
Returns!
MUTATION

adminCreatePlatformNotificationChannel

#

Create a new notification channel. PlatformAdmin only.

Arguments

  • input!
Returns!
MUTATION

adminCreateRegionExclusivity

#

Create a region exclusivity agreement for a tenant. PlatformAdmin only. If monthly_price_minor is omitted the price is auto-calculated from the city's population tier and country GDP data.

Arguments

  • input!
Returns!
MUTATION

adminCreateTenant

#

Create a new tenant as PlatformAdmin. When skip_verification is true, tenant + admin account are created immediately. When false, an invitation email is sent with a 7-day verification link.

Arguments

  • input!
Returns!
MUTATION

adminCreditTenantWallet

#

Grant credit to a tenant's plan-credit wallet (PlatformAdmin only). Records an AdminGiftCredit ledger transaction; idempotency is on the caller — every call adds another grant.

Arguments

  • input!
Returns!
MUTATION

adminDeletePlatformNotificationChannel

#

Delete a channel. PlatformAdmin only. Returns true on success.

Arguments

  • idString!
ReturnsBoolean!
MUTATION

adminDeleteStoreCredential

#

Remove a platform store credential (polling for that store stops).

Arguments

  • store!
ReturnsBoolean!
MUTATION

adminExtendSubscription

#

Extend a subscription's period (PlatformAdmin only).

Arguments

  • subscriptionId!
  • extendDaysInt!
Returns!
MUTATION

adminGrantPlatformAddon

#

Grant a platform-controlled addon to a tenant. PlatformAdmin only. expires_at = None makes the grant indefinite. Re-granting an existing addon overwrites the previous record (new granted_by and granted_at stamps; new expiry).

Arguments

  • input!
Returns!
MUTATION

adminProvisionRegistration

#

Force-create a tenant from a pending or email-verified registration. Admin picks a plan — the tenant, account, and subscription are created immediately, bypassing the user's onboarding flow. PlatformAdmin only. Force-create with a specific plan. Falls back to the registration's plan or the default trial.

Arguments

  • input
  • details
ReturnsBoolean!
MUTATION

adminReactivateSubscription

#

Reactivate a cancelled (or cancel-at-period-end) subscription (PlatformAdmin only).

Arguments

  • subscriptionId!
Returns!
MUTATION

adminRefreshStoreReleases

#

Run the store poll synchronously — all platform apps, or one app when connectedAppId is given. Pairs poll concurrently and the whole run is capped at 60s so the request can't outlive edge timeouts; per-app failures land in errors without failing the mutation.

Arguments

  • connectedAppIdID
Returns!
MUTATION

adminRemoveOperationCity

#

Remove a city from a tenant's operation areas (PlatformAdmin only).

Arguments

  • tenantId!
  • cityId!
ReturnsBoolean!
MUTATION

adminRetryTenantDataWipe

#

Re-queue a FAILED wipe. Sets the row back to PENDING with execute_at = now() so the worker picks it up on its next tick. Step-up gated — same protection as scheduling a fresh wipe.

Arguments

  • id!
Returns!
MUTATION

adminRevokeCountryExclusivity

#

Revoke (deactivate) a country exclusivity agreement. PlatformAdmin only.

Arguments

  • id!
ReturnsBoolean!
MUTATION

adminRevokePlatformAddon

#

Revoke a previously granted addon. PlatformAdmin only. The grant record is kept (with enabled = false) so the audit trail of past activations is recoverable from the config history. A subsequent grant will overwrite it.

Arguments

  • input!
ReturnsBoolean!
MUTATION

adminRevokeRegionExclusivity

#

Revoke (deactivate) a region exclusivity agreement. PlatformAdmin only.

Arguments

  • id!
ReturnsBoolean!
MUTATION

adminScheduleTenantDataWipe

#

Schedule a tenant data wipe with a 12-hour grace window. The data is not deleted immediately; a background worker executes the request after execute_at. Cancel within the window via adminCancelTenantDataWipe. Step-up gated — the platform admin must re-enter their password to mint an elevation token before this mutation will proceed.

Arguments

  • input!
Returns!
MUTATION

adminSendOperatorWelcome

#

Send a workspace's welcome emails, one per product it has (PlatformAdmin only). Without previewTo, sends every welcome the workspace has not had yet to its owner — the same send that runs on its own when a workspace is created — and reports products already welcomed as ALREADY_SENT. With previewTo, sends them all to that address instead and records nothing, so the workspace still gets its own welcomes afterwards.

Arguments

  • tenantId!
  • previewToString

    Send to this address instead of the owner, and record nothing.

Returns[!]!
MUTATION

adminSetBillingEmail

#

Set or clear the billing email override on a subscription (PlatformAdmin only).

Arguments

  • subscriptionId!
  • billingEmailString

    New billing email; null falls back to the workspace admin email.

Returns!
MUTATION

adminSetCancelAtPeriodEnd

#

Toggle cancel-at-period-end on a subscription (PlatformAdmin only).

Arguments

  • subscriptionId!
  • cancelAtPeriodEndBoolean!
Returns!
MUTATION

adminSetGraceUntil

#

Set or clear the grace-period end on a subscription (PlatformAdmin only).

Arguments

  • subscriptionId!
  • graceUntil

    New grace-until; null clears the grace period.

Returns!
MUTATION

adminSetPauseUntil

#

Set or clear the pause end on a subscription (PlatformAdmin only).

Arguments

  • subscriptionId!
  • pauseUntil

    New pause-until; null clears the pause.

Returns!
MUTATION

adminSetSubscriptionCustomLimits

#

Set or clear custom per-subscription limit overrides (PlatformAdmin only). Input must be a JSON object keyed by limit_id (e.g. {"max_drivers": 250}).

Arguments

  • subscriptionId!
  • customLimitsJsonString

    JSON object keyed by limit_id; null clears all overrides.

Returns!
MUTATION

adminSetSubscriptionVerticals

#

Replace the selected verticals on a subscription (PlatformAdmin only). The subscription row is only half of a vertical grant. Everything that makes a vertical usable — the owner's allowed_apps, the system subdomain, the per-vertical defaults, the brand slot — is derived from the verticals once at onboarding and never revisited, so changing this column alone left the tenant with a vertical they were still locked out of. provision_added_verticals replays that provisioning for whatever is new; it is idempotent, so a grant that adds nothing is a no-op.

Arguments

  • subscriptionId!
  • verticals[!]!
Returns!
MUTATION

adminSetTrialEnd

#

Set or clear the trial end date on a subscription (PlatformAdmin only).

Arguments

  • subscriptionId!
  • trialEnd

    New trial end; null clears the trial end.

Returns!
MUTATION

adminSuspendTenant

#

Suspend a tenant (PlatformAdmin only).

Arguments

  • id!
Returns!
MUTATION

adminTestPlatformNotificationChannel

#

Send a synchronous test notification to a channel. PlatformAdmin only. Returns true when the underlying HTTP call succeeded.

Arguments

  • idString!
ReturnsBoolean!
MUTATION

adminUnblockTenant

#

Unblock a blocked tenant (PlatformAdmin only). Restores the tenant to Active status.

Arguments

  • id!
Returns!
MUTATION

adminUpdatePlatformNotificationChannel

#

Update an existing channel. PlatformAdmin only.

Arguments

  • input!
Returns!
MUTATION

adminUpdateSubscriptionStatus

#

Override a subscription's status (PlatformAdmin only).

Arguments

  • subscriptionId!
  • status!
Returns!
MUTATION

adminUpdateTenant

#

Update tenant fields (PlatformAdmin only).

Arguments

  • input!
Returns!
MUTATION

adminUpsertAppStoreCredential

#

Store (or replace) the platform App Store Connect API key. The key material is encrypted at rest and never readable back over the API.

Arguments

  • input!
Returns!
MUTATION

adminUpsertGooglePlayCredential

#

Store (or replace) the platform Google Play service account. The JSON key is encrypted at rest and never readable back over the API.

Arguments

  • input!
Returns!
MUTATION

adminVerifyRegistrationEmail

#

Verify a pending registration's email. Moves status to EmailVerified so the user can log in and complete onboarding (plan selection + payment) themselves. Bypasses email token and expiry. PlatformAdmin only.

Arguments

  • idString!
ReturnsBoolean!
MUTATION

applyTenantWalletToBilling

#

Forward the tenant wallet's credit (in currency) to the active subscription's PSP customer balance. Idempotent in the sense that repeated calls when the wallet is empty are no-ops.

Arguments

  • currencyString!
Returns!
MUTATION

cancelSubscription

#

Cancel the current subscription.

Arguments

  • input!
Returns!
MUTATION

changePlan

#

Upgrade or downgrade the subscription plan.

Arguments

  • input!
Returns!
MUTATION

changeTenantSlug

#

Change the workspace's slug — the root of every system subdomain (<slug>-<app>.<apex>). What moves and what does not: * every system host is rebuilt on the new slug, in one transaction with the slug itself; * the previous slug stays reserved to this workspace. Its hosts redirect to the new ones, no other workspace can take it, and the workspace may change back to it; * custom domains are untouched and stay verified. Those the workspace fronts with a proxy of its own come back in customDomainsToRepoint, as advice; * customers signed in to the web apps sign in again — the new hosts are new origins — and passkeys bound to an old system host have to be added again (those users fall back to a code). Owner and admin passkeys are bound to the apex and keep working. Limited to one change every 30 days; TenantEntity.canChangeSlug and slugChangeAvailableAt say so before the attempt, and checkSlugChange says whether a particular slug would be accepted. Owner only, and step-up gated: the caller must hold a fresh elevation token. A refusal carries extensions.code — SLUG_INVALID, SLUG_RESERVED, SLUG_UNCHANGED, SLUG_TAKEN, SLUG_CHANGE_TOO_SOON (with availableAt), SLUG_CHANGE_CONFLICT or SLUG_CHANGE_NOT_ALLOWED.

Arguments

  • newSlugString!

    The new slug: 3-40 lowercase letters, digits and single hyphens, not starting or ending with a hyphen.

Returns!
MUTATION

completeOnboarding

#

Complete onboarding by subscribing to a plan. Creates the tenant, admin account, and subscription. Returns new authentication tokens for the created tenant admin.

Arguments

  • input!
Returns!
MUTATION

confirmCheckoutSession

#

Finalize a Stripe checkout without waiting for the webhook. The client calls this on return from checkout. We retrieve the session from Stripe, reject it if it hasn't completed + paid, then run the same provisioning the webhook does. If the webhook already processed it, this returns alreadyProcessed = true instead of double-provisioning. No GraphQL authentication required — the registration flow calls this before the tenant exists, so there's no session to bind to. The session_id itself is the authenticator: it's unguessable and Stripe only hands it out to the paying user, and the mutation can only produce side effects if the PSP confirms the session is complete + paid.

Arguments

  • input!
Returns!
MUTATION

createApiKey

#

Create a new API key for the tenant. The plaintext key is returned only once. Store it securely. Requires Owner-tier (TenantOwner or PlatformAdmin) — issuing a long-lived backend credential is a danger-zone action.

Arguments

  • input!
Returns!
MUTATION

createBillingPortalSession

#

Create a Stripe Billing Portal session. Returns the portal URL.

Arguments

  • returnUrlString!
ReturnsString!
MUTATION

createBillingSetupSession

#

Start collecting a payment method for a subscription that has none. A cardless trial has no PSP identity at all — no customer, no subscription — so there is nothing for the billing portal to open, and subscribeToPlan short-circuits back into another cardless trial for any plan with allow_cardless. Without this the tenant is told to add a card by the dashboard banner and the reminder email, has no way to do so, and is suspended when the trial ends. This opens an ordinary subscription checkout for the plan they are already on, carrying the *remaining* trial so adding a card neither charges them early nor extends what they were promised. The existing checkout.session.completed handling provisions the paid subscription and vaults the card; nothing new is needed on the webhook side.

Arguments

  • input!
ReturnsString!
MUTATION

createConnectedApp

#

Create a connected app. * ownership = Platform — PlatformAdmin only, tenantId must be null. * ownership = Tenant — any admin, tenantId must be set (tenant admins may only create rows for their own tenant).

Arguments

  • input
  • details
Returns!
MUTATION

createRegistrationCheckout

#

Create a Stripe checkout session for an email-verified registration. No tenant exists yet — the webhook will create it after payment. No authentication required (the registration_id serves as the identifier).

Arguments

  • input
  • details
Returns!
MUTATION

createSitePreview

#

A signed link, valid for 30 minutes, that shows the draft on the real site. Open url in the preview frame.

Returns!
MUTATION

deleteConnectedApp

#

Soft-delete a connected app. Same authorization rules as update.

Arguments

  • idID!
ReturnsBoolean!
MUTATION

deleteMyBlogCategory

#

Delete a category. Its posts stay, uncategorized.

Arguments

  • idID!
ReturnsBoolean!
MUTATION

deleteMyBlogPost

#

Delete a post for good.

Arguments

  • idID!
ReturnsBoolean!
MUTATION

disablePlatformConnectedApp

#

Opt the tenant out of a platform-owned app — it stops appearing in AASA / assetlinks for that tenant's domains.

Arguments

  • connectedAppIdID!
  • tenantIdID
ReturnsBoolean!
MUTATION

enablePlatformConnectedApp

#

Re-enable (i.e., remove from the opt-out set) a previously-disabled platform app for the tenant.

Arguments

  • connectedAppIdID!
  • tenantIdID
ReturnsBoolean!
MUTATION

enableSite

#

Turn the site on: generates a starter draft from the workspace's brand, business types and apps. Nothing is public until publishSite. The site is written in one language: language (one the workspace offers; default: the workspace's default language). template is the look it starts with, an id from siteTemplates (default: the one made for the workspace's business type, else classic). Either one refused is SITE_INVALID. Idempotent: a workspace that has a site gets it back unchanged, and both arguments are then ignored.

Arguments

  • templateString
  • languageString
Returns!
MUTATION

generateBranding

#

Generate a brand from a curated style and the operator's brand colour. Renders every mark variant, materialises each into an upload, and stores the recipe alongside so the brand can be re-rendered when the name or style changes. Non-mark company fields (name, links, legal) are preserved — this replaces the *marks*, not the identity. Requires an admin-tier caller: tenant admin, tenant owner, or an impersonating platform admin.

Arguments

  • input!
Returns!
MUTATION

previewLegacyPurchaseCode

#

Validate a code without consuming it. Surfaces "already redeemed" so the UI can warn the user before they commit.

Arguments

  • input!
Returns!
MUTATION

provisionTenantStoreReviewer

#

Provision (or sync) the store-review account. Three branches, see StoreReviewManagementUseCase docs: 1. Account missing → returns credentials (one-time plaintext). 2. Account exists, roles drifted → returns info + synced_roles. 3. Account exists, roles current → errors. Caller should switch to the password reset action.

Returns!
MUTATION

provisionTenantTesters

#

Provision (or top up) the auto roster — one tester per (app, role) slot for the tenant's subscribed verticals. Idempotent.

Returns!
MUTATION

publishMyBlogPost

#

Make a post public now.

Arguments

  • idID!
Returns!
MUTATION

publishSite

#

Make the draft the live site. expectedUpdatedAt is the updatedAt of the draft the operator was looking at.

Arguments

  • expectedUpdatedAt!
Returns!
MUTATION

reactivateSubscription

#

Reactivate a cancelled subscription (before period end).

Returns!
MUTATION

redeemLegacyPurchaseCode

#

Redeem a legacy purchase code, crediting the tenant wallet by the exact amount the customer originally paid. Single-use per code.

Arguments

  • input!
Returns!
MUTATION

registerTenant

#

Register a new tenant. Sends a verification email to the admin. No authentication required.

Arguments

  • input!
Returns!
MUTATION

removeCustomDomain

#

Remove a custom domain. Only custom domains can be removed; system domains are managed automatically.

Arguments

  • idString!
ReturnsBoolean!
MUTATION

removeOperationCity

#

Remove a city from the current tenant's operation areas. This permanently drops the row from the allow-list. Use setOperationCityActive to soft-disable instead — disabled rows stay parked for one-click reactivation.

Arguments

  • cityId!
ReturnsBoolean!
MUTATION

removeSiteCustomDomain

#

Stop serving the site on its custom domain. Owner only, with a step-up confirmation like removing an app's custom domain: it changes where the workspace's visitors land.

ReturnsBoolean!
MUTATION

removeTenantTester

#

Remove a tester account. Returns true if a tester was deleted.

Arguments

  • accountId!
ReturnsBoolean!
MUTATION

renameTenant

#

Rename the workspace. The name is display copy — it is what customers read in the apps, the store listings and every outgoing email — so it may be written in the operator's own script. The slug is *not* touched: it is the root of every system subdomain, and moving it is its own operation with its own cooldown (changeTenantSlug). Rate-limited to one change every 30 days, because a rename is one keystroke to make and days to propagate through app stores, caches and already-sent mail. TenantEntity.canChangeName and nameChangeAvailableAt let the console show that before the attempt. Accessible by: - **TenantOwner / TenantAdmin**: their own workspace, cooldown enforced. - **PlatformAdmin**: any workspace (pass tenant_id), cooldown waived so support can fix a name the owner cannot yet fix themselves.

Arguments

  • tenantId

    Target workspace. Required for PlatformAdmin; ignored for workspace admins (uses own workspace).

  • nameString!

    The new display name. Any script; 1-255 characters.

Returns!
MUTATION

resendVerificationEmail

#

Resend the verification email for a pending registration. Rate limited: max 5 resends, 60s cooldown between resends. No authentication required.

Arguments

  • emailString!
Returns!
MUTATION

resetTenantStoreReviewerPassword

#

Rotate the reviewer's password and return the new plaintext once. Errors with "store-review account not found" if the reviewer hasn't been provisioned yet.

Returns!
MUTATION

revokeAllApiKeys

#

Revoke all API keys for the tenant. All keys will immediately become invalid. Use with caution! Requires Owner-tier (TenantOwner or PlatformAdmin).

Arguments

  • input!
Returns!
MUTATION

revokeApiKey

#

Revoke a single API key. The key will immediately become invalid for authentication. Requires Owner-tier (TenantOwner or PlatformAdmin).

Arguments

  • input!
Returns!
MUTATION

rollbackBranding

#

Rollback branding to a previous version. Creates a new version with the content from the specified version. Requires an admin-tier caller: tenant admin, tenant owner, or an impersonating platform admin.

Arguments

  • versionInt!
Returns!
MUTATION

rotateApiKey

#

Rotate an API key (revoke old and create new in one operation). This enables zero-downtime key rotation by creating the new key before revoking the old one. Requires Owner-tier (TenantOwner or PlatformAdmin) **and** a fresh step-up elevation token — rotation is a destructive security action that should be paired with a re-auth so a stolen Owner session can't quietly mint a long-lived key.

Arguments

  • input!
Returns!
MUTATION

saveMyBlogCategory

Deprecated#

Create a category (no id) or rename one. At most 30 per workspace.

Deprecation reason: Use saveMyBlogCategoryDetails; BET-205

Arguments

  • input!
Returns!
MUTATION

saveMyBlogCategoryDetails

#

Arguments

  • input!
Returns!
MUTATION

saveMyBlogPost

#

Create a post (no id) or change one. A new post is a draft; a changed one keeps its status, so an edit of a live post is live at once. BLOG_INVALID lists the fields that broke a rule, BLOG_SLUG_TAKEN, BLOG_LIMIT_REACHED (500 posts) and BLOG_STALE (the post changed since expectedUpdatedAt) are the other refusals.

Arguments

  • input!
Returns!
MUTATION

saveSiteDraft

#

Replace the draft. Refused with SITE_DRAFT_STALE when the draft has changed since expectedUpdatedAt, and with SITE_INVALID (and the list of violations) when the content breaks a rule.

Arguments

  • input!
Returns!
MUTATION

saveTenantConfig

#

Save a tenant configuration (TenantAdmin for own tenant, PlatformAdmin for any). Creates a new versioned revision and sets it as current. Provide exactly one config variant via the @oneOf input.

Arguments

  • tenantId

    Target tenant ID. Required for PlatformAdmin; uses own tenant for TenantAdmin.

  • config!
ReturnsBoolean!
MUTATION

scheduleMyBlogPost

#

Make a post public at publishAt, which must be in the future.

Arguments

  • idID!
  • publishAt!
Returns!
MUTATION

setOperationCityActive

#

Toggle the active state of an existing operation city. Activating a row enforces the plan locations limit (it consumes a slot). Deactivating frees the slot but keeps the row in the allow-list so the tenant can flip it back without rediscovering the city.

Arguments

  • cityId!
  • activeBoolean!
ReturnsBoolean!
MUTATION

setPlanCardless

#

Set whether plan_id may be started cardless. PlatformAdmin only. Returns the new value.

Arguments

  • planIdString!
  • allowCardlessBoolean!
ReturnsBoolean!
MUTATION

setPlanUsageRate

#

Set a plan's rate for one vertical, from effective_from (defaulting to now). PlatformAdmin only. A change is a new row, never an edit: a period that has already been billed must keep re-computing to what was actually charged. Back-dating past a closed period is therefore possible and would produce a rate that disagrees with an invoice already sent — so it is refused.

Arguments

  • planIdString!
  • verticalString!
  • rateBpsInt!
  • effectiveFromString
Returns!
MUTATION

setSiteCustomDomain

#

Serve the site on a domain of the workspace's own (www.acme.com). Owner only. The domain is registered with the same edge provider as an app's custom domain; point its CNAME record at cnameTarget and call verifySiteCustomDomain. Once live it is the site's address and the slug host redirects to it. Replaces any domain the site had.

Arguments

  • domainString!
Returns!
MUTATION

setSiteLeadRead

#

Mark an enquiry read (read: true, the default) or unread.

Arguments

  • id!
  • readBoolean!

    Default

    true
Returns!
MUTATION

setTenantDiscoverable

#

Toggle whether a tenant is publicly discoverable. Accessible by: - **TenantAdmin**: can toggle discoverability of their own tenant. - **PlatformAdmin**: can toggle discoverability of any tenant (pass tenant_id).

Arguments

  • tenantId

    Target tenant. Required for PlatformAdmin; ignored for TenantAdmin (uses own tenant).

  • discoverableBoolean!
Returns!
MUTATION

setTenantIsDemo

#

Toggle whether a tenant is a demo/test tenant. Demo tenants get relaxed auth and extra UI features. This is a platform-level setting and can only be changed by PlatformAdmin.

Arguments

  • tenantId!
  • isDemoBoolean!
Returns!
MUTATION

setVerticalAppBrand

#

Set or update branding for a specific app within a vertical. Requires an admin-tier caller: tenant admin, tenant owner, or an impersonating platform admin.

Arguments

  • vertical!
  • app!
  • input!
Returns!
MUTATION

setVerticalBrand

#

Set or update branding for a specific vertical. Requires an admin-tier caller: tenant admin, tenant owner, or an impersonating platform admin.

Arguments

  • vertical!
  • input!
Returns!
MUTATION

submitSiteLead

#

An enquiry from the contact form of the site on host. Delivered to the workspace's inbox and emailed to its owner. Throttled per visitor address and per site (RATE_LIMITED). A filled website field is a bot: reported as accepted, stored nowhere.

Arguments

  • input!
Returns!
MUTATION

subscribeToPlan

#

Start the subscription flow. Creates a Stripe Checkout Session and returns the checkout URL. No subscription is saved until the checkout completes and the webhook fires.

Arguments

  • input
  • details
Returns!
MUTATION

unpublishMyBlogPost

#

Take a post down. It stays a draft.

Arguments

  • idID!
Returns!
MUTATION

unpublishSite

#

Take the live site down. The draft and the address stay; the host answers 404 until the next publish.

Returns!
MUTATION

updateAuthPolicy

#

Save a new revision of the tenant's AuthPolicy. Requires TenantAdmin (or PlatformAdmin impersonation). The payload replaces the rule set in full — there's no merge semantics, the version-bump-per-save pattern matches update_tier_config.

Arguments

  • input!
Returns!
MUTATION

updateBranding

#

Update the entire branding configuration. Creates a new version and sets it as current. Requires an admin-tier caller: tenant admin, tenant owner, or an impersonating platform admin.

Arguments

  • input!
Returns!
MUTATION

updateCompanyBrand

#

Update only the company brand. Preserves existing vertical brands. Requires an admin-tier caller: tenant admin, tenant owner, or an impersonating platform admin.

Arguments

  • input!
Returns!
MUTATION

updateConnectedApp

#

Update mutable fields on a connected app. Ownership and platform are immutable — delete + recreate if those need to change.

Arguments

  • input!
Returns!
MUTATION

updateOnboardingBusiness

#

Persist the business name + a unique slug on an email-verified registration. No authentication required (the registration_id is the identifier).

Arguments

  • input!
Returns!
MUTATION

updateRegionalSettings

#

Update regional settings configuration. Sets locale, measurement system, time format, map defaults, wallet top-up presets, and support contact for the tenant. Creates a new version and sets it as current. Requires TenantAdmin role.

Arguments

  • input!
Returns!
MUTATION

updateTierConfig

#

Save a new revision of the tenant's tier policy (display names, verification ladder, expiry days, strike thresholds, payment-method requirement). Requires TenantAdmin role.

Arguments

  • input
  • details
Returns!
MUTATION

verifyCustomDomain

#

Verify DNS for a custom domain by checking host resolution. The tenant must have already set up a CNAME record pointing the custom domain to the system subdomain. This mutation performs a basic DNS lookup to confirm the domain resolves. Full CNAME chain verification may be added later.

Arguments

  • idString!
Returns!
MUTATION

verifySiteCustomDomain

#

Check the custom domain with the provider. For admins and the owner.

Returns!
MUTATION

verifyTenantRegistration

#

Verify a tenant registration email token. Marks the registration as EmailVerified — no tenant is created yet. The user must log in and complete onboarding (plan subscription) to become a real tenant. No authentication required.

Arguments

  • tokenString!
Returns!