Skip to content
Build with Mammoth › CLI reference: open the docs menu

mammoth support

Generated from mammoth-cli 2.4.2, released 2026-11-02: mammoth schema list, mammoth capability list and the CLI's own --help. Do not edit by hand; run npm run docs:capabilities.

Manage support and administration resources. 117 commands.

Every command also takes the global flags (--output, --yes, --confirm, --dry-run, --input, --profile, ...), which are not repeated below. --input takes a JSON or YAML document of the input fields; mammoth schema get COMMAND_ID prints a command's full input schema.

Confirmation. Commands marked --yes --confirm TARGET or --yes always need those flags, even at a terminal: they never prompt. Commands marked "--yes or prompt" ask at an interactive terminal (table output, no --no-input) and otherwise need --yes. --dry-run skips confirmation and sends nothing.

Summary

CommandWhat it doesEffectConfirmation
support searchSearch workspaces, partners and users. The text is a positional or q.Read—
support triageShow the triage queue: what needs attention.Read—
support usage-tilesShow the usage tiles.Read—
support billing cancel-subscriptionCancel a workspace's subscription (when: now or period_end). Workspace id is positional.High impact--yes --confirm TARGET
support billing change-planMove a workspace to another plan. Workspace id and new plan id are positional.High impact--yes --confirm TARGET
support billing end-trialEnd a workspace's trial now and charge the plan. Workspace id is positional.High impact--yes --confirm TARGET
support billing refundRefund a workspace's last payment: amount (cents) of it, or all of it with full.Destructive--yes --confirm TARGET
support billing retry-paymentRetry a workspace's failed payment. Workspace id is positional.High impact--yes --confirm TARGET
support billing start-trialStart a trial on a workspace. Workspace id is positional; days (1-60) is optional.High impact--yes --confirm TARGET
support connector bucket-impactShow which plans a connector's bucket change would reach. Connector id is positional.Read—
support connector createCreate a connector. Name comes from a positional or the 'name' field.High impact--yes --confirm TARGET
support connector deleteDelete one connector by id.High impact--yes --confirm TARGET
support connector listList all subscription connectors.Read—
support connector updateUpdate a connector. Connector id is positional; fields come from '--input'.High impact--yes --confirm TARGET
support connector-profile add-connectorAdd a connector to a connector profile. Profile id is positional.High impact--yes --confirm TARGET
support connector-profile createCreate a connector profile. Name comes from a positional or 'name' field.High impact--yes --confirm TARGET
support connector-profile deleteDelete one connector profile by id.High impact--yes --confirm TARGET
support connector-profile listList all connector profiles.Read—
support connector-profile updateUpdate a connector profile. Profile id is positional; fields from '--input'.High impact--yes --confirm TARGET
support deal activityList a deal's activity log.Read—
support deal cancel-move-to-partnerCancel a deal's pending move to a partner. Deal id is positional.High impact--yes --confirm TARGET
support deal createCreate a deal on a workspace (positional id) or on a new one (workspace_create).High impact--yes --confirm TARGET
support deal getGet one deal by id.Read—
support deal listList all deals.Read—
support deal move-to-partnerSchedule a direct deal to move under a partner. Deal and partner ids are positional.High impact--yes --confirm TARGET
support deal opt-inRelease a deal's opt-in rollout pins (keys, connectors or everything).High impact--yes --confirm TARGET
support deal preview-entitlementPreview the entitlements a deal grants, without changing anything.Read—
support deal updateUpdate a deal's terms or status. Deal id is positional; the changes come from --input.High impact--yes --confirm TARGET
support entitlement registryList the entitlement registry: every entitlement key a plan or deal can set.Read—
support feature createCreate a feature. Name comes from a positional or the 'name' field.High impact--yes --confirm TARGET
support feature deleteDelete one feature by id.High impact--yes --confirm TARGET
support feature listList all subscription features.Read—
support feature updateUpdate a feature. Feature id is positional; fields come from '--input'.High impact--yes --confirm TARGET
support feature-profile add-featureAdd a feature to a feature profile. Profile id is positional.High impact--yes --confirm TARGET
support feature-profile createCreate a feature profile. Name comes from a positional or 'name' field.High impact--yes --confirm TARGET
support feature-profile deleteDelete one feature profile by id.High impact--yes --confirm TARGET
support feature-profile listList all feature profiles.Read—
support feature-profile updateUpdate a feature profile. Profile id is positional; fields from '--input'.High impact--yes --confirm TARGET
support identity getGet one identity by user id.Read—
support identity listList identities (users across workspaces).Read—
support ownership transferTransfer ownership of a workspace. Workspace id is positional.High impact--yes --confirm TARGET
support partner activityList a partner's activity log.Read—
support partner billingShow a partner's billing summary.Read—
support partner charge-invoicesCharge a partner's open invoices now. Partner id is positional.High impact--yes --confirm TARGET
support partner client cancel-detachCancel a client workspace's pending detach. Partner id and workspace id are positional.High impact--yes --confirm TARGET
support partner client deleteDelete a client workspace of a partner. Partner id and workspace id are positional.Destructive--yes --confirm TARGET
support partner client detachDetach a partner client workspace into a direct deal. Both ids are positional.High impact--yes --confirm TARGET
support partner client listList a partner's client workspaces.Read—
support partner createCreate a partner. Name comes from a positional or the 'name' field.High impact--yes --confirm TARGET
support partner getGet one partner by id.Read—
support partner invoicesList a partner's invoices.Read—
support partner listList all partners.Read—
support partner send-payment-linkEmail a partner its payment link. Partner id is positional.High impact--yes --confirm TARGET
support partner updateUpdate a partner. Partner id is positional; the changes come from --input.High impact--yes --confirm TARGET
support plan archiveArchive one subscription plan by id.High impact--yes --confirm TARGET
support plan catalogList the plans catalog with the entitlement values each plan carries.Read—
support plan chargebee-listList available Chargebee plans/resources.Read—
support plan createCreate a subscription plan. Name is positional; required fields from '--input'.High impact--yes --confirm TARGET
support plan deleteDelete one subscription plan by id.High impact--yes --confirm TARGET
support plan getGet one subscription plan by id.Read—
support plan listList all subscription plans.Read—
support plan self-serve-listList self-serve subscription plans.Read—
support plan storage-option archivePlatform admin only: archive one storage option of a plan (never deleted).High impact--yes --confirm TARGET
support plan storage-option createPlatform admin only: add a storage option (total GB and prices) to a plan.High impact--yes --confirm TARGET
support plan storage-option listPlatform admin only: list a plan's storage options, archived ones included.Read—
support plan storage-option updatePlatform admin only: re-price or resize one storage option of a plan.High impact--yes --confirm TARGET
support plan unarchivePlatform admin only: unarchive one subscription plan by id.High impact--yes --confirm TARGET
support plan updateUpdate a subscription plan. Plan id is positional; fields from '--input'.High impact--yes --confirm TARGET
support plan update-entitlementsEdit a plan's entitlement values (its column of the entitlement matrix).High impact--yes --confirm TARGET
support plan update-storage-tiersReplace a plan's storage pricing tiers. Plan id is positional.High impact--yes --confirm TARGET
support project-move getGet a project move's status, error and progress.Read—
support project-move purgeQueue deleting the source copies a finished project move left behind.High impact--yes --confirm TARGET
support subscription createRegister a workspace's Chargebee subscription. Workspace id is positional.High impact--yes --confirm TARGET
support subscription getGet a workspace's Chargebee subscription details. Workspace id is positional.Read—
support subscription updateUpdate a workspace's Chargebee subscription id. Workspace id is positional.High impact--yes --confirm TARGET
support template auditPlatform admin only: re-run every curated-catalog gate (read-only).Read—
support template canvasPlatform admin only: read a curated template's canvas, drafts included.Read—
support template data-previewPlatform admin only: read up to 50 rows of the data a curated template opens on.Read—
support template discardPlatform admin only: permanently remove a curated draft, its board and its data.Destructive--yes --confirm TARGET
support template editPlatform admin only: edit a curated template's filing ('changes' from '--input').High impact--yes --confirm TARGET
support template exportPlatform admin only: download a curated template as a .zip template file.Read—
support template export-dashboardPlatform admin only: download a dashboard you can edit as a .zip template file.Read—
support template importPlatform admin only: import a template file (.zip) as a curated draft. '--yes' required.High impact--yes
support template inspectPlatform admin only: read a template file (.zip) without importing it.Read—
support template listPlatform admin only: list every curated template, drafts and faults first.Read—
support template publishPlatform admin only: take a curated draft live in every customer's gallery.High impact--yes --confirm TARGET
support template retirePlatform admin only: retire a curated template (kept, no longer offered).High impact--yes --confirm TARGET
support template snapshotsPlatform admin only: list every stored dataset the template catalog holds.Read—
support template thumbnail clearPlatform admin only: remove a curated template's picture.High impact--yes --confirm TARGET
support template thumbnail setPlatform admin only: upload or replace a curated template's picture from FILE.High impact--yes --confirm TARGET
support template unpublishPlatform admin only: take a live or retired curated template back to draft.High impact--yes --confirm TARGET
support user list-allList users across workspaces.Read—
support user registerRegister a new user. Email is positional; required fields from '--input'.High impact--yes --confirm TARGET
support user updateUpdate a user's verification status. Email is positional.High impact--yes --confirm TARGET
support workspace activityList a workspace's activity log.Read—
support workspace archiveArchive a workspace to cold storage. confirm_name must be the workspace's name.High impact--yes --confirm TARGET
support workspace archive-infoShow what archiving a workspace would do, and its archive state.Read—
support workspace chargebee-cancelledRecord a workspace's Chargebee subscription as cancelled. Workspace id is positional.High impact--yes --confirm TARGET
support workspace createCreate a workspace. Name is positional; required fields from '--input'.High impact--yes --confirm TARGET
support workspace deal-seedShow the deal terms a workspace's current subscription would seed.Read—
support workspace deleteDelete one workspace by id.High impact--yes --confirm TARGET
support workspace entitlementShow the entitlements a workspace resolves to.Read—
support workspace getGet details of a workspace. Workspace id is positional.Read—
support workspace invite cancelCancel a pending workspace invite. Workspace id and invite id are positional.High impact--yes --confirm TARGET
support workspace invite resendResend a pending workspace invite. Workspace id and invite id are positional.High impact--yes --confirm TARGET
support workspace listList all workspaces visible to the current admin/support user.Read—
support workspace project listList a workspace's projects with their unfinished project moves.Read—
support workspace project move-checkCheck, read-only, moving a project to another workspace.Read—
support workspace project move-startStart moving a project to another workspace, or resume its unfinished move.High impact--yes --confirm TARGET
support workspace restore-accessRestore user access to a suspended workspace. Workspace id is positional.High impact--yes --confirm TARGET
support workspace restore-archiveRestore an archived workspace from cold storage. Workspace id is positional.High impact--yes --confirm TARGET
support workspace suspend-accessSuspend user access to a workspace. Workspace id is positional.High impact--yes --confirm TARGET
support workspace updateUpdate a workspace's details/subscription. Workspace id is positional.High impact--yes --confirm TARGET
support workspace user addAdd a user to a workspace. Workspace id is positional.High impact--yes --confirm TARGET
support workspace user listList users in a workspace. Workspace id is positional.Read—
support workspace user removeRemove a user from a workspace. Workspace id is positional.High impact--yes --confirm TARGET
support workspace user transferTransfer/change a user's role within a workspace. Workspace id is positional.High impact--yes --confirm TARGET

support commands

Search workspaces, partners and users. The text is a positional or q.

mammoth support search acme
NamePassed asRequiredDefaultTypeNotes
Qpositionalno—strText to search for (a workspace, user, deal or partner); or the 'q' field. Or the q input field.
q--input fieldno—str
  • Effect: Read, scope workspace · Confirmation: none
  • Id: support.search · Result: SupportSearchResult · Backed by: SDK mammoth.api.support.SupportAPI.search, API GET /support/search (SupportSearch)

mammoth support triage

Show the triage queue: what needs attention.

mammoth support triage
  • Effect: Read, scope workspace · Confirmation: none
  • Id: support.triage · Result: SupportTriageResult · Backed by: SDK mammoth.api.support.SupportAPI.triage, API GET /support/triage (SupportTriage)

mammoth support usage-tiles

Show the usage tiles.

mammoth support usage-tiles
  • Effect: Read, scope workspace · Confirmation: none
  • Id: support.usage-tiles · Result: SupportUsageTilesResult · Backed by: SDK mammoth.api.support.SupportAPI.usage_tiles, API GET /support/usage-tiles (SupportUsageTiles)

support billing

mammoth support billing cancel-subscription

Cancel a workspace's subscription (when: now or period_end). Workspace id is positional.

mammoth support billing cancel-subscription 123 --input '{"when": "period_end"}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
when--input fieldyes—str
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. when is required: now ends access and billing at once, period_end keeps the workspace until the paid period ends. Check support workspace entitlement WORKSPACE_ID first.
  • Id: support.billing.cancel-subscription · Result: SupportBillingCancelSubscriptionResult · Backed by: SDK mammoth.api.support.SupportAPI.billing_cancel_subscription, API POST /support/billing/{workspace_id}/cancel-subscription (SupportCancelSubscription)

mammoth support billing change-plan

Move a workspace to another plan. Workspace id and new plan id are positional.

mammoth support billing change-plan 123 456 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
NEW_PLAN_IDpositionalyes—intID of the new plan.
when--input fieldnonowstr
storage_gb--input fieldno—int
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. A workspace billed through a partner is refused: change it on the partner instead. Look the plan up with support plan catalog; when is now or period_end. A change now is prorated and billed at once.
  • Id: support.billing.change-plan · Result: SupportBillingChangePlanResult · Backed by: SDK mammoth.api.support.SupportAPI.billing_change_plan, API POST /support/billing/{workspace_id}/change-plan (SupportChangePlan)

mammoth support billing end-trial

End a workspace's trial now and charge the plan. Workspace id is positional.

mammoth support billing end-trial 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. A workspace billed through a partner is refused: change it on the partner instead. Ends the trial now and charges the plan; the card on file is billed.
  • Id: support.billing.end-trial · Result: SupportBillingEndTrialResult · Backed by: SDK mammoth.api.support.SupportAPI.billing_end_trial, API POST /support/billing/{workspace_id}/end-trial (SupportEndTrial)

mammoth support billing refund

Refund a workspace's last payment: amount (cents) of it, or all of it with full.

mammoth support billing refund 123 --input '{"amount": 500}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
amount--input fieldno—int
full--input fieldnofalsebool
  • Effect: Destructive, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. A workspace billed through a partner is refused: change it on the partner instead. Moves money back to the customer, and it cannot be undone. Exactly one of amount (positive whole cents, a partial refund) or full: true (the whole last payment) is required: neither, or both, is refused, so a refund is never full by omission. The confirmation text names the amount or FULL.
  • Id: support.billing.refund · Result: SupportBillingRefundResult · Backed by: SDK mammoth.api.support.SupportAPI.billing_refund, API POST /support/billing/{workspace_id}/refund (SupportRefund)

mammoth support billing retry-payment

Retry a workspace's failed payment. Workspace id is positional.

mammoth support billing retry-payment 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. A workspace billed through a partner is refused: change it on the partner instead. Charges the failed invoice again; the card on file is billed.
  • Id: support.billing.retry-payment · Result: SupportBillingRetryPaymentResult · Backed by: SDK mammoth.api.support.SupportAPI.billing_retry_payment, API POST /support/billing/{workspace_id}/retry-payment (SupportRetryPayment)

mammoth support billing start-trial

Start a trial on a workspace. Workspace id is positional; days (1-60) is optional.

mammoth support billing start-trial 123 --input '{"days": 14}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
days--input fieldno—int
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Starts a trial of days (1-60) on the workspace. It REPLACES the workspace's billing and cancels a live paid Stripe subscription. Check support workspace entitlement WORKSPACE_ID first.
  • Id: support.billing.start-trial · Result: SupportBillingStartTrialResult · Backed by: SDK mammoth.api.support.SupportAPI.billing_start_trial, API POST /support/billing/{workspace_id}/start-trial (SupportStartTrial)

support connector

mammoth support connector bucket-impact

Show which plans a connector's bucket change would reach. Connector id is positional.

mammoth support connector bucket-impact 123
NamePassed asRequiredDefaultTypeNotes
CONNECTOR_IDpositionalyes—intID of the connector.
bucket--input fieldno—str
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: CONNECTOR_ID.
  • Id: support.connector.bucket-impact · Result: SupportConnectorBucketImpactResult · Backed by: SDK mammoth.api.support.SupportAPI.connector_bucket_impact, API GET /support/connectors/{connector_id}/bucket-impact (SupportConnectorBucketImpact)

mammoth support connector create

Create a connector. Name comes from a positional or the 'name' field.

mammoth support connector create 'Revenue report' --yes --confirm 'Revenue report'
NamePassed asRequiredDefaultTypeNotes
NAMEpositionalno—strName of the new connector; or pass it via the 'name' input field. Or the name input field.
name--input fieldno—str
description--input fieldno—str
price_per_month--input fieldno0float
enabled--input fieldnotruebool
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Support staff only. Adds a connector to the catalog for every workspace. Needs --yes and --confirm TARGET.
  • Id: support.connector.create · Result: SupportConnectorCreateResult · Backed by: SDK mammoth.api.support.SupportAPI.connector_create, API POST /subscription/connectors (CreateConnector)

mammoth support connector delete

Delete one connector by id.

mammoth support connector delete 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
CONNECTOR_IDpositionalyes—intID of the connector.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: CONNECTOR_ID.
  • Id: support.connector.delete · Result: SupportConnectorDeleteResult · Backed by: SDK mammoth.api.support.SupportAPI.connector_delete, API DELETE /subscription/connectors/{connector_id} (DeleteConnector)

mammoth support connector list

List all subscription connectors.

mammoth support connector list
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Id: support.connector.list · Result: SupportConnectorListResult · Backed by: SDK mammoth.api.support.SupportAPI.connector_list, API GET /subscription/connectors (ListSubscriptionConnectors)

mammoth support connector update

Update a connector. Connector id is positional; fields come from '--input'.

mammoth support connector update 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
CONNECTOR_IDpositionalyes—intID of the connector.
name--input fieldno—str
description--input fieldno—str
price_per_month--input fieldno—float
enabled--input fieldno—bool
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: CONNECTOR_ID.
  • Id: support.connector.update · Result: SupportConnectorUpdateResult · Backed by: SDK mammoth.api.support.SupportAPI.connector_update, API PUT /subscription/connectors/{connector_id} (UpdateConnector)

support connector-profile

mammoth support connector-profile add-connector

Add a connector to a connector profile. Profile id is positional.

mammoth support connector-profile add-connector 123 456 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PROFILE_IDpositionalyes—intID of the profile.
CONNECTOR_IDpositionalyes—intID of the connector.
price_per_month--input fieldno0float
enabled--input fieldnotruebool
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: PROFILE_ID, CONNECTOR_ID.
  • Id: support.connector-profile.add-connector · Result: SupportConnectorProfileAddConnectorResult · Backed by: SDK mammoth.api.support.SupportAPI.connector_profile_add_connector, API POST /subscription/connector-profiles/{profile_id}/connectors (AddConnectorToProfile)

mammoth support connector-profile create

Create a connector profile. Name comes from a positional or 'name' field.

mammoth support connector-profile create 'Revenue report' --yes --confirm 'Revenue report'
NamePassed asRequiredDefaultTypeNotes
NAMEpositionalno—strName of the new connector profile; or pass it via the 'name' input field. Or the name input field.
name--input fieldno—str
description--input fieldno—str
connectors--input fieldno—list[dict[str, any]]
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Support staff only. Creates a connector profile that workspaces can be assigned. Needs --yes and --confirm TARGET.
  • Id: support.connector-profile.create · Result: SupportConnectorProfileCreateResult · Backed by: SDK mammoth.api.support.SupportAPI.connector_profile_create, API POST /subscription/connector-profiles (CreateConnectorProfile)

mammoth support connector-profile delete

Delete one connector profile by id.

mammoth support connector-profile delete 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PROFILE_IDpositionalyes—intID of the profile.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: PROFILE_ID.
  • Id: support.connector-profile.delete · Result: SupportConnectorProfileDeleteResult · Backed by: SDK mammoth.api.support.SupportAPI.connector_profile_delete, API DELETE /subscription/connector-profiles/{profile_id} (DeleteConnectorProfile)

mammoth support connector-profile list

List all connector profiles.

mammoth support connector-profile list
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Id: support.connector-profile.list · Result: SupportConnectorProfileListResult · Backed by: SDK mammoth.api.support.SupportAPI.connector_profile_list, API GET /subscription/connector-profiles (ListConnectorProfiles)

mammoth support connector-profile update

Update a connector profile. Profile id is positional; fields from '--input'.

mammoth support connector-profile update 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PROFILE_IDpositionalyes—intID of the profile.
name--input fieldno—str
description--input fieldno—str
connectors--input fieldno—list[dict[str, any]]
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: PROFILE_ID.
  • Id: support.connector-profile.update · Result: SupportConnectorProfileUpdateResult · Backed by: SDK mammoth.api.support.SupportAPI.connector_profile_update, API PUT /subscription/connector-profiles/{profile_id} (UpdateConnectorProfile)

support deal

mammoth support deal activity

List a deal's activity log.

mammoth support deal activity 123
NamePassed asRequiredDefaultTypeNotes
DEAL_IDpositionalyes—intID of the deal.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: DEAL_ID.
  • Id: support.deal.activity · Result: SupportDealActivityResult · Backed by: SDK mammoth.api.support.SupportAPI.deal_activity, API GET /support/deals/{deal_id}/activity (SupportDealActivity)

mammoth support deal cancel-move-to-partner

Cancel a deal's pending move to a partner. Deal id is positional.

mammoth support deal cancel-move-to-partner 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
DEAL_IDpositionalyes—intID of the deal.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Cancels the deal's pending move to a partner; read the deal first with support deal get DEAL_ID.
  • Id: support.deal.cancel-move-to-partner · Result: SupportDealCancelMoveToPartnerResult · Backed by: SDK mammoth.api.support.SupportAPI.deal_cancel_move_to_partner, API DELETE /support/deals/{deal_id}/move-to-partner (SupportDealCancelMoveToPartner)

mammoth support deal create

Create a deal on a workspace (positional id) or on a new one (workspace_create).

mammoth support deal create 123 --input '{"base_plan_id": 3, "price": 1200.0}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalno—intID of the workspace to put the deal on; omit it and pass 'workspace_create'.
base_plan_id--input fieldyes—int
price--input fieldno—float
billing_interval--input fieldno—str
collection_method--input fieldno—str
currency--input fieldno—str
ent_overrides--input fieldno—dict[str, any]
custom_connectors--input fieldno—list[str]
contract_start--input fieldno—str
contract_end--input fieldno—str
trial_end--input fieldno—str
payment_terms--input fieldno—str
notes--input fieldno—str
contact_name--input fieldno—str
contact_email--input fieldno—str
workspace_create--input fieldno—dict[str, any]
customer_email--input fieldno—str
partner_id--input fieldno—int
billing_start--input fieldno—str
billing_start_at--input fieldno—str
status--input fieldno—str
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Needs base_plan_id and exactly one of the WORKSPACE_ID argument or workspace_create. A deal sets what the workspace is billed and entitled to.
  • Id: support.deal.create · Result: SupportDealCreateResult · Backed by: SDK mammoth.api.support.SupportAPI.deal_create, API POST /support/deals (SupportCreateDeal)

mammoth support deal get

Get one deal by id.

mammoth support deal get 123
NamePassed asRequiredDefaultTypeNotes
DEAL_IDpositionalyes—intID of the deal.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: DEAL_ID.
  • Id: support.deal.get · Result: SupportDealGetResult · Backed by: SDK mammoth.api.support.SupportAPI.deal_get, API GET /support/deals/{deal_id} (SupportGetDeal)

mammoth support deal list

List all deals.

mammoth support deal list
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Id: support.deal.list · Result: SupportDealListResult · Backed by: SDK mammoth.api.support.SupportAPI.deal_list, API GET /support/deals (SupportListDeals)

mammoth support deal move-to-partner

Schedule a direct deal to move under a partner. Deal and partner ids are positional.

mammoth support deal move-to-partner 123 456 --input '{"price": 900.0, "billing_interval": "monthly"}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
DEAL_IDpositionalyes—intID of the deal.
PARTNER_IDpositionalyes—intID of the partner.
price--input fieldyes—float
billing_interval--input fieldyes—str
when--input fieldnoperiod_endstr
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Moves the deal's billing under a partner (when: period_end or now). With when now, the workspace's subscription is cancelled prorated and the unused time is refunded. Undo a pending move with support deal cancel-move-to-partner DEAL_ID.
  • Id: support.deal.move-to-partner · Result: SupportDealMoveToPartnerResult · Backed by: SDK mammoth.api.support.SupportAPI.deal_move_to_partner, API POST /support/deals/{deal_id}/move-to-partner (SupportDealMoveToPartner)

mammoth support deal opt-in

Release a deal's opt-in rollout pins (keys, connectors or everything).

mammoth support deal opt-in 123 --input '{"everything": true}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
DEAL_IDpositionalyes—intID of the deal.
keys--input fieldno—list[str]
connectors--input fieldno—list[str]
everything--input fieldnofalsebool
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Releases opt-in rollout pins on the deal (keys, connectors, or everything), which can change the workspace's entitlements at once.
  • Id: support.deal.opt-in · Result: SupportDealOptInResult · Backed by: SDK mammoth.api.support.SupportAPI.deal_opt_in, API POST /support/deals/{deal_id}/opt-in (SupportDealOptIn)

mammoth support deal preview-entitlement

Preview the entitlements a deal grants, without changing anything.

mammoth support deal preview-entitlement 123
NamePassed asRequiredDefaultTypeNotes
DEAL_IDpositionalyes—intID of the deal.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: DEAL_ID.
  • Id: support.deal.preview-entitlement · Result: SupportDealPreviewEntitlementResult · Backed by: SDK mammoth.api.support.SupportAPI.deal_preview_entitlement, API GET /support/deals/{deal_id}/preview-entitlement (SupportPreviewDealEntitlement)

mammoth support deal update

Update a deal's terms or status. Deal id is positional; the changes come from --input.

mammoth support deal update 123 --input '{"notes": "Renewal agreed"}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
DEAL_IDpositionalyes—intID of the deal.
price--input fieldno—float
billing_interval--input fieldno—str
collection_method--input fieldno—str
currency--input fieldno—str
base_plan_id--input fieldno—int
ent_overrides--input fieldno—dict[str, any]
custom_connectors--input fieldno—list[str]
contract_start--input fieldno—str
contract_end--input fieldno—str
trial_end--input fieldno—str
payment_terms--input fieldno—str
notes--input fieldno—str
contact_name--input fieldno—str
contact_email--input fieldno—str
status--input fieldno—str
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Changes what the workspace is billed and entitled to; a bad status turns entitlements off. Read the deal first with support deal get DEAL_ID, and preview the result with support deal preview-entitlement DEAL_ID.
  • Id: support.deal.update · Result: SupportDealUpdateResult · Backed by: SDK mammoth.api.support.SupportAPI.deal_update, API PUT /support/deals/{deal_id} (SupportUpdateDeal)

support entitlement

mammoth support entitlement registry

List the entitlement registry: every entitlement key a plan or deal can set.

mammoth support entitlement registry
  • Effect: Read, scope workspace · Confirmation: none
  • Id: support.entitlement.registry · Result: SupportEntitlementRegistryResult · Backed by: SDK mammoth.api.support.SupportAPI.entitlement_registry, API GET /support/entitlements (SupportEntitlementRegistry)

support feature

mammoth support feature create

Create a feature. Name comes from a positional or the 'name' field.

mammoth support feature create 'Revenue report' --yes --confirm 'Revenue report'
NamePassed asRequiredDefaultTypeNotes
NAMEpositionalno—strName of the new feature; or pass it via the 'name' input field. Or the name input field.
name--input fieldno—str
description--input fieldno—str
price_per_month--input fieldno0float
enabled--input fieldnotruebool
values--input fieldno—list[str]
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Support staff only. Adds a feature flag to the catalog for every workspace. Needs --yes and --confirm TARGET.
  • Id: support.feature.create · Result: SupportFeatureCreateResult · Backed by: SDK mammoth.api.support.SupportAPI.feature_create, API POST /subscription/features (CreateFeature)

mammoth support feature delete

Delete one feature by id.

mammoth support feature delete 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
FEATURE_IDpositionalyes—intID of the feature.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: FEATURE_ID.
  • Id: support.feature.delete · Result: SupportFeatureDeleteResult · Backed by: SDK mammoth.api.support.SupportAPI.feature_delete, API DELETE /subscription/features/{feature_id} (DeleteFeature)

mammoth support feature list

List all subscription features.

mammoth support feature list
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Id: support.feature.list · Result: SupportFeatureListResult · Backed by: SDK mammoth.api.support.SupportAPI.feature_list, API GET /subscription/features (ListFeatures)

mammoth support feature update

Update a feature. Feature id is positional; fields come from '--input'.

mammoth support feature update 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
FEATURE_IDpositionalyes—intID of the feature.
name--input fieldno—str
description--input fieldno—str
price_per_month--input fieldno—float
enabled--input fieldno—bool
values--input fieldno—list[str]
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: FEATURE_ID.
  • Id: support.feature.update · Result: SupportFeatureUpdateResult · Backed by: SDK mammoth.api.support.SupportAPI.feature_update, API PUT /subscription/features/{feature_id} (UpdateFeature)

support feature-profile

mammoth support feature-profile add-feature

Add a feature to a feature profile. Profile id is positional.

mammoth support feature-profile add-feature 123 456 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PROFILE_IDpositionalyes—intID of the profile.
FEATURE_IDpositionalyes—intID of the feature.
price_per_month--input fieldno0float
enabled--input fieldnotruebool
value--input fieldno—str
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: PROFILE_ID, FEATURE_ID.
  • Id: support.feature-profile.add-feature · Result: SupportFeatureProfileAddFeatureResult · Backed by: SDK mammoth.api.support.SupportAPI.feature_profile_add_feature, API POST /subscription/feature-profiles/{profile_id}/features (AddFeatureToProfile)

mammoth support feature-profile create

Create a feature profile. Name comes from a positional or 'name' field.

mammoth support feature-profile create 'Revenue report' --yes --confirm 'Revenue report'
NamePassed asRequiredDefaultTypeNotes
NAMEpositionalno—strName of the new feature profile; or pass it via the 'name' input field. Or the name input field.
name--input fieldno—str
description--input fieldno—str
features--input fieldno—list[dict[str, any]]
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Support staff only. Creates a feature profile that workspaces can be assigned. Needs --yes and --confirm TARGET.
  • Id: support.feature-profile.create · Result: SupportFeatureProfileCreateResult · Backed by: SDK mammoth.api.support.SupportAPI.feature_profile_create, API POST /subscription/feature-profiles (CreateFeatureProfile)

mammoth support feature-profile delete

Delete one feature profile by id.

mammoth support feature-profile delete 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PROFILE_IDpositionalyes—intID of the profile.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: PROFILE_ID.
  • Id: support.feature-profile.delete · Result: SupportFeatureProfileDeleteResult · Backed by: SDK mammoth.api.support.SupportAPI.feature_profile_delete, API DELETE /subscription/feature-profiles/{profile_id} (DeleteFeatureProfile)

mammoth support feature-profile list

List all feature profiles.

mammoth support feature-profile list
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Id: support.feature-profile.list · Result: SupportFeatureProfileListResult · Backed by: SDK mammoth.api.support.SupportAPI.feature_profile_list, API GET /subscription/feature-profiles (ListFeatureProfiles)

mammoth support feature-profile update

Update a feature profile. Profile id is positional; fields from '--input'.

mammoth support feature-profile update 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PROFILE_IDpositionalyes—intID of the profile.
name--input fieldno—str
description--input fieldno—str
features--input fieldno—list[dict[str, any]]
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: PROFILE_ID.
  • Id: support.feature-profile.update · Result: SupportFeatureProfileUpdateResult · Backed by: SDK mammoth.api.support.SupportAPI.feature_profile_update, API PUT /subscription/feature-profiles/{profile_id} (UpdateFeatureProfile)

support identity

mammoth support identity get

Get one identity by user id.

mammoth support identity get 123
NamePassed asRequiredDefaultTypeNotes
USER_IDpositionalyes—intID of the user.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: USER_ID.
  • Id: support.identity.get · Result: SupportIdentityGetResult · Backed by: SDK mammoth.api.support.SupportAPI.identity_get, API GET /support/identities/{user_id} (SupportGetIdentity)

mammoth support identity list

List identities (users across workspaces).

mammoth support identity list
NamePassed asRequiredDefaultTypeNotes
limit--input fieldno—int
offset--input fieldno—int
search--input fieldno—str
sort--input fieldno—str
order--input fieldno—str
  • Effect: Read, scope workspace · Confirmation: none · Pages: offset
  • Id: support.identity.list · Result: SupportIdentityListResult · Backed by: SDK mammoth.api.support.SupportAPI.identity_list, API GET /support/identities (SupportListIdentities)

support ownership

mammoth support ownership transfer

Transfer ownership of a workspace. Workspace id is positional.

mammoth support ownership transfer 123 456 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
USER_IDpositionalyes—intID of the user.
new_role--input fieldnoworkspace_ownerstr
remove_role--input fieldno—str
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: WORKSPACE_ID, USER_ID.
  • Id: support.ownership.transfer · Result: SupportOwnershipTransferResult · Backed by: SDK mammoth.api.support.SupportAPI.ownership_transfer, API PATCH /settings/users (TransferOwnerships)

support partner

mammoth support partner activity

List a partner's activity log.

mammoth support partner activity 123
NamePassed asRequiredDefaultTypeNotes
PARTNER_IDpositionalyes—intID of the partner.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: PARTNER_ID.
  • Id: support.partner.activity · Result: SupportPartnerActivityResult · Backed by: SDK mammoth.api.support.SupportAPI.partner_activity, API GET /support/partners/{partner_id}/activity (SupportPartnerActivity)

mammoth support partner billing

Show a partner's billing summary.

mammoth support partner billing 123
NamePassed asRequiredDefaultTypeNotes
PARTNER_IDpositionalyes—intID of the partner.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: PARTNER_ID.
  • Id: support.partner.billing · Result: SupportPartnerBillingResult · Backed by: SDK mammoth.api.support.SupportAPI.partner_billing, API GET /support/partners/{partner_id}/billing (SupportGetPartnerBilling)

mammoth support partner charge-invoices

Charge a partner's open invoices now. Partner id is positional.

mammoth support partner charge-invoices 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PARTNER_IDpositionalyes—intID of the partner.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Charges every open invoice of the partner now; the partner's card on file is billed. Look at them first with support partner invoices PARTNER_ID.
  • Id: support.partner.charge-invoices · Result: SupportPartnerChargeInvoicesResult · Backed by: SDK mammoth.api.support.SupportAPI.partner_charge_invoices, API POST /support/partners/{partner_id}/charge-invoices (SupportChargePartnerInvoices)

mammoth support partner client cancel-detach

Cancel a client workspace's pending detach. Partner id and workspace id are positional.

mammoth support partner client cancel-detach 123 456 --yes --confirm 456
NamePassed asRequiredDefaultTypeNotes
PARTNER_IDpositionalyes—intID of the partner.
WORKSPACE_IDpositionalyes—intID of the workspace.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Cancels the client's pending detach. Confirm with the WORKSPACE id (--confirm WORKSPACE_ID, the second argument), not the partner id. List the clients first with support partner client list PARTNER_ID.
  • Id: support.partner.client.cancel-detach · Result: SupportPartnerClientCancelDetachResult · Backed by: SDK mammoth.api.support.SupportAPI.partner_client_cancel_detach, API DELETE /support/partners/{partner_id}/workspaces/{workspace_id}/detach (SupportCancelDetachClient)

mammoth support partner client delete

Delete a client workspace of a partner. Partner id and workspace id are positional.

mammoth support partner client delete 123 456 --yes --confirm 456
NamePassed asRequiredDefaultTypeNotes
PARTNER_IDpositionalyes—intID of the partner.
WORKSPACE_IDpositionalyes—intID of the workspace.
  • Effect: Destructive, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Deletes the client workspace of the partner, and it cannot be undone. Confirm with the WORKSPACE id (--confirm WORKSPACE_ID, the second argument), not the partner id. List them first with support partner client list PARTNER_ID.
  • Id: support.partner.client.delete · Result: SupportPartnerClientDeleteResult · Backed by: SDK mammoth.api.support.SupportAPI.partner_client_delete, API DELETE /support/partners/{partner_id}/workspaces/{workspace_id} (SupportDeletePartnerClient)

mammoth support partner client detach

Detach a partner client workspace into a direct deal. Both ids are positional.

mammoth support partner client detach 123 456 --input '{"price": 900.0, "contact_email": "owner@example.com"}' --yes --confirm 456
NamePassed asRequiredDefaultTypeNotes
PARTNER_IDpositionalyes—intID of the partner.
WORKSPACE_IDpositionalyes—intID of the workspace.
price--input fieldyes—float
contact_email--input fieldyes—str
billing_interval--input fieldno—str
collection_method--input fieldno—str
currency--input fieldno—str
base_plan_id--input fieldno—int
ent_overrides--input fieldno—dict[str, any]
custom_connectors--input fieldno—list[str]
contract_start--input fieldno—str
contract_end--input fieldno—str
trial_end--input fieldno—str
payment_terms--input fieldno—str
notes--input fieldno—str
contact_name--input fieldno—str
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Turns the partner's client into a direct customer: price (above 0) and contact_email are required. Confirm with the WORKSPACE id (--confirm WORKSPACE_ID, the second argument), not the partner id. Undo a pending detach with support partner client cancel-detach PARTNER_ID WORKSPACE_ID.
  • Id: support.partner.client.detach · Result: SupportPartnerClientDetachResult · Backed by: SDK mammoth.api.support.SupportAPI.partner_client_detach, API POST /support/partners/{partner_id}/workspaces/{workspace_id}/detach (SupportDetachClient)

mammoth support partner client list

List a partner's client workspaces.

mammoth support partner client list 123
NamePassed asRequiredDefaultTypeNotes
PARTNER_IDpositionalyes—intID of the partner.
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Preconditions: Required inputs: PARTNER_ID.
  • Id: support.partner.client.list · Result: SupportPartnerClientListResult · Backed by: SDK mammoth.api.support.SupportAPI.partner_client_list, API GET /support/partners/{partner_id}/workspaces (SupportListPartnerClients)

mammoth support partner create

Create a partner. Name comes from a positional or the 'name' field.

mammoth support partner create 'Revenue report' --yes --confirm 'Revenue report'
NamePassed asRequiredDefaultTypeNotes
NAMEpositionalno—strName of the new partner; or pass it via the 'name' input field. Or the name input field.
name--input fieldno—str
contact_name--input fieldno—str
contact_email--input fieldno—str
payment_terms--input fieldno—str
billing_method--input fieldno—str
notes--input fieldno—str
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Creates a partner record; no money moves.
  • Id: support.partner.create · Result: SupportPartnerCreateResult · Backed by: SDK mammoth.api.support.SupportAPI.partner_create, API POST /support/partners (SupportCreatePartner)

mammoth support partner get

Get one partner by id.

mammoth support partner get 123
NamePassed asRequiredDefaultTypeNotes
PARTNER_IDpositionalyes—intID of the partner.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: PARTNER_ID.
  • Id: support.partner.get · Result: SupportPartnerGetResult · Backed by: SDK mammoth.api.support.SupportAPI.partner_get, API GET /support/partners/{partner_id} (SupportGetPartner)

mammoth support partner invoices

List a partner's invoices.

mammoth support partner invoices 123
NamePassed asRequiredDefaultTypeNotes
PARTNER_IDpositionalyes—intID of the partner.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: PARTNER_ID.
  • Id: support.partner.invoices · Result: SupportPartnerInvoicesResult · Backed by: SDK mammoth.api.support.SupportAPI.partner_invoices, API GET /support/partners/{partner_id}/invoices (SupportListPartnerInvoices)

mammoth support partner list

List all partners.

mammoth support partner list
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Id: support.partner.list · Result: SupportPartnerListResult · Backed by: SDK mammoth.api.support.SupportAPI.partner_list, API GET /support/partners (SupportListPartners)

Email a partner its payment link. Partner id is positional.

mammoth support partner send-payment-link 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PARTNER_IDpositionalyes—intID of the partner.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Emails the partner contact a payment link; the email goes out at once.
  • Id: support.partner.send-payment-link · Result: SupportPartnerSendPaymentLinkResult · Backed by: SDK mammoth.api.support.SupportAPI.partner_send_payment_link, API POST /support/partners/{partner_id}/send-payment-link (SupportSendPartnerPaymentLink)

mammoth support partner update

Update a partner. Partner id is positional; the changes come from --input.

mammoth support partner update 123 --input '{"notes": "Prefers invoices"}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PARTNER_IDpositionalyes—intID of the partner.
name--input fieldno—str
contact_name--input fieldno—str
contact_email--input fieldno—str
payment_terms--input fieldno—str
billing_method--input fieldno—str
status--input fieldno—str
notes--input fieldno—str
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. An empty string clears contact_name, contact_email or notes. billing_method sets how the partner's consolidated subscription is collected.
  • Id: support.partner.update · Result: SupportPartnerUpdateResult · Backed by: SDK mammoth.api.support.SupportAPI.partner_update, API PUT /support/partners/{partner_id} (SupportUpdatePartner)

support plan

mammoth support plan archive

Archive one subscription plan by id.

mammoth support plan archive 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PLAN_IDpositionalyes—intID of the plan.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: PLAN_ID.
  • Id: support.plan.archive · Result: SupportPlanArchiveResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_archive, API POST /subscription/plans/{plan_id}/archive (ArchivePlan)

mammoth support plan catalog

List the plans catalog with the entitlement values each plan carries.

mammoth support plan catalog
  • Effect: Read, scope workspace · Confirmation: none
  • Id: support.plan.catalog · Result: SupportPlanCatalogResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_catalog, API GET /support/plans/catalog (SupportPlansCatalog)

mammoth support plan chargebee-list

List available Chargebee plans/resources.

mammoth support plan chargebee-list
NamePassed asRequiredDefaultTypeNotes
resource--input fieldnoplansstr
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Id: support.plan.chargebee-list · Result: SupportPlanChargebeeListResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_chargebee_list, API GET /support/sms (GetPlans)

mammoth support plan create

Create a subscription plan. Name is positional; required fields from '--input'.

mammoth support plan create 'Revenue report' --input '{"monthly_price": 1.0, "is_self_serve": true}' --yes --confirm 'Revenue report'
NamePassed asRequiredDefaultTypeNotes
NAMEpositionalno—strName of the new plan; or pass it via the 'name' input field. Or the name input field.
name--input fieldno—str
monthly_price--input fieldyes—float
is_self_serve--input fieldyes—bool
display_name--input fieldno—str
description--input fieldno—str
annual_price--input fieldno—float
annual_only--input fieldnofalsebool
trial_days--input fieldno—int
storage_amount--input fieldno0int
max_storage--input fieldno—int
max_users--input fieldno—int
no_of_users--input fieldno—int
seat_price--input fieldno—float
number_of_tiers--input fieldno1int
storage_block_size--input fieldno—int
tiers--input fieldno—list[dict[str, any]]
connector_profile_id--input fieldno—int
feature_profile_id--input fieldno—int
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Support staff only. Creates a billing plan that workspaces can subscribe to. Needs --yes and --confirm TARGET.
  • Id: support.plan.create · Result: SupportPlanCreateResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_create, API POST /subscription/plans (CreatePlan)

mammoth support plan delete

Delete one subscription plan by id.

mammoth support plan delete 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PLAN_IDpositionalyes—intID of the plan.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: PLAN_ID.
  • Id: support.plan.delete · Result: SupportPlanDeleteResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_delete, API DELETE /subscription/plans/{plan_id} (DeletePlan)

mammoth support plan get

Get one subscription plan by id.

mammoth support plan get 123
NamePassed asRequiredDefaultTypeNotes
PLAN_IDpositionalyes—intID of the plan.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: PLAN_ID.
  • Id: support.plan.get · Result: SupportPlanGetResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_get, API GET /subscription/plans/{plan_id} (GetPlan)

mammoth support plan list

List all subscription plans.

mammoth support plan list
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Id: support.plan.list · Result: SupportPlanListResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_list, API GET /subscription/plans (ListSubscriptionPlans)

mammoth support plan self-serve-list

List self-serve subscription plans.

mammoth support plan self-serve-list
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Id: support.plan.self-serve-list · Result: SupportPlanSelfServeListResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_self_serve_list, API GET /subscription/self-serve-plans (ListSelfServePlans)

mammoth support plan storage-option archive

Platform admin only: archive one storage option of a plan (never deleted).

mammoth support plan storage-option archive 123 456 --yes --confirm 456
NamePassed asRequiredDefaultTypeNotes
PLAN_IDpositionalyes—intID of the plan.
OPTION_IDpositionalyes—intID of the option.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Retires the option so it can no longer be chosen; never deleted, subscriptions billed at that size keep it. Confirm with the option id.
  • Id: support.plan.storage-option.archive · Result: SupportPlanStorageOptionArchiveResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_storage_option_archive, API DELETE /subscription/plans/{plan_id}/storage-options/{option_id} (ArchiveStorageOption)

mammoth support plan storage-option create

Platform admin only: add a storage option (total GB and prices) to a plan.

mammoth support plan storage-option create 123 --input '{"storage_gb": 1, "monthly_price": 1.0, "annual_price": 1.0}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PLAN_IDpositionalyes—intID of the plan.
storage_gb--input fieldyes—int
monthly_price--input fieldyes—float
annual_price--input fieldyes—float
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Adds a purchasable storage size to an inline-pricing plan. storage_gb is the TOTAL allocation, not an increment; prices are the monthly and annual add on top of the plan price.
  • Id: support.plan.storage-option.create · Result: SupportPlanStorageOptionCreateResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_storage_option_create, API POST /subscription/plans/{plan_id}/storage-options (CreateStorageOption)

mammoth support plan storage-option list

Platform admin only: list a plan's storage options, archived ones included.

mammoth support plan storage-option list 123
NamePassed asRequiredDefaultTypeNotes
PLAN_IDpositionalyes—intID of the plan.
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Every purchasable storage size of the plan, archived ones included.
  • Id: support.plan.storage-option.list · Result: SupportPlanStorageOptionListResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_storage_option_list, API GET /subscription/plans/{plan_id}/storage-options (ListStorageOptions)

mammoth support plan storage-option update

Platform admin only: re-price or resize one storage option of a plan.

mammoth support plan storage-option update 123 456 --yes --confirm 456
NamePassed asRequiredDefaultTypeNotes
PLAN_IDpositionalyes—intID of the plan.
OPTION_IDpositionalyes—intID of the option.
storage_gb--input fieldno—int
monthly_price--input fieldno—float
annual_price--input fieldno—float
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Re-prices or resizes one storage option; send at least one of storage_gb, monthly_price, annual_price. Confirm with the option id.
  • Id: support.plan.storage-option.update · Result: SupportPlanStorageOptionUpdateResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_storage_option_update, API PUT /subscription/plans/{plan_id}/storage-options/{option_id} (UpdateStorageOption)

mammoth support plan unarchive

Platform admin only: unarchive one subscription plan by id.

mammoth support plan unarchive 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PLAN_IDpositionalyes—intID of the plan.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Unarchives a plan archived with support plan archive.
  • Id: support.plan.unarchive · Result: SupportPlanUnarchiveResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_unarchive, API POST /subscription/plans/{plan_id}/unarchive (UnarchivePlan)

mammoth support plan update

Update a subscription plan. Plan id is positional; fields from '--input'.

mammoth support plan update 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PLAN_IDpositionalyes—intID of the plan.
name--input fieldno—str
description--input fieldno—str
monthly_price--input fieldno—float
annual_price--input fieldno—float
annual_only--input fieldno—bool
is_self_serve--input fieldno—bool
trial_days--input fieldno—int
storage_amount--input fieldno—int
max_storage--input fieldno—int
max_users--input fieldno—int
no_of_users--input fieldno—int
seat_price--input fieldno—float
number_of_tiers--input fieldno—int
storage_block_size--input fieldno—int
tiers--input fieldno—list[dict[str, any]]
connector_profile_id--input fieldno—int
feature_profile_id--input fieldno—int
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: PLAN_ID.
  • Id: support.plan.update · Result: SupportPlanUpdateResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_update, API PUT /subscription/plans/{plan_id} (UpdatePlan)

mammoth support plan update-entitlements

Edit a plan's entitlement values (its column of the entitlement matrix).

mammoth support plan update-entitlements 123 --input '{"values": {"dashboardBranding": "no_branding"}}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PLAN_IDpositionalyes—intID of the plan.
values--input fieldyes—dict[str, bool | int | str | None]
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Changes what every workspace on the plan is granted, at once. Legacy and system plans are read-only. Read support plan get first. Needs --yes and --confirm PLAN_ID (the refusal prints the exact target). --dry-run names the plan and the new values; the plan's current values are not readable from a mapped read, so compare with the plans matrix.
  • Id: support.plan.update-entitlements · Result: SupportPlanUpdateEntitlementsResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_update_entitlements, API PUT /subscription/plans/{plan_id}/entitlements (UpdatePlanEntitlements)

mammoth support plan update-storage-tiers

Replace a plan's storage pricing tiers. Plan id is positional.

mammoth support plan update-storage-tiers 123 --input '{"storage_tiers": [{"name": "Status"}]}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
PLAN_IDpositionalyes—intID of the plan.
storage_tiers--input fieldyes—list[dict[str, any]]
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: PLAN_ID.
  • Id: support.plan.update-storage-tiers · Result: SupportPlanUpdateStorageTiersResult · Backed by: SDK mammoth.api.support.SupportAPI.plan_update_storage_tiers, API PUT /subscription/plans/{plan_id}/storage-tiers (UpdateStorageTiers)

support project-move

mammoth support project-move get

Get a project move's status, error and progress.

mammoth support project-move get 123
NamePassed asRequiredDefaultTypeNotes
MOVE_IDpositionalyes—intID of the move.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Tech admin only (Mammoth staff role); refused for every other user. Needs no workspace header. A move that is stalled (its worker died) resumes when support workspace project move-start runs again.
  • Id: support.project-move.get · Result: SupportProjectMoveGetResult · Backed by: SDK mammoth.api.support.SupportAPI.project_move_get, API GET /support/project-moves/{move_id} (GetProjectMove)

mammoth support project-move purge

Queue deleting the source copies a finished project move left behind.

mammoth support project-move purge 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
MOVE_IDpositionalyes—intID of the move.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Tech admin only (Mammoth staff role); refused for every other user. Refused for a move that is not finished.
  • Id: support.project-move.purge · Result: SupportProjectMovePurgeResult · Backed by: SDK mammoth.api.support.SupportAPI.project_move_purge, API POST /support/project-moves/{move_id}/purge (PurgeProjectMove)

support subscription

mammoth support subscription create

Register a workspace's Chargebee subscription. Workspace id is positional.

mammoth support subscription create 123 resource-123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
PLAN_IDpositionalyes—strID of the plan.
customer_id--input fieldno—str
first_name--input fieldno—str
last_name--input fieldno—str
email--input fieldno—str
company_name--input fieldno—str
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: WORKSPACE_ID, PLAN_ID.
  • Id: support.subscription.create · Result: SupportSubscriptionCreateResult · Backed by: SDK mammoth.api.support.SupportAPI.subscription_create, API POST /support/workspaces/{workspace_id}/sms (RegisterSubscription)

mammoth support subscription get

Get a workspace's Chargebee subscription details. Workspace id is positional.

mammoth support subscription get 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
fields--input fieldno—str
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: WORKSPACE_ID.
  • Id: support.subscription.get · Result: SupportSubscriptionGetResult · Backed by: SDK mammoth.api.support.SupportAPI.subscription_get, API GET /support/workspaces/{workspace_id}/sms (GetSubscriptionDetail)

mammoth support subscription update

Update a workspace's Chargebee subscription id. Workspace id is positional.

mammoth support subscription update 123 resource-123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
SUBSCRIPTION_IDpositionalyes—strID of the subscription.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: WORKSPACE_ID, SUBSCRIPTION_ID.
  • Id: support.subscription.update · Result: SupportSubscriptionUpdateResult · Backed by: SDK mammoth.api.support.SupportAPI.subscription_update, API PATCH /support/workspaces/{workspace_id}/sms (UpdateSubscription)

support template

mammoth support template audit

Platform admin only: re-run every curated-catalog gate (read-only).

mammoth support template audit
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Re-runs every curated-catalog gate: faults with remedies, checked, and curated entries never seeded (missing). Read-only.
  • Id: support.template.audit · Result: SupportTemplateAuditResult · Backed by: SDK mammoth.api.support.SupportAPI.template_audit, API GET /dashboards/v3/templates/admin/audit (DashboardV3AdminAudit)

mammoth support template canvas

Platform admin only: read a curated template's canvas, drafts included.

mammoth support template canvas revenue-overview
NamePassed asRequiredDefaultTypeNotes
SLUGpositionalyes—strCurated template slug.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. The template's canvas with its baked plan and specs, drafts included.
  • Id: support.template.canvas · Result: SupportTemplateCanvasResult · Backed by: SDK mammoth.api.support.SupportAPI.template_canvas, API GET /dashboards/v3/templates/admin/{slug}/canvas (DashboardV3AdminRowCanvas)

mammoth support template data-preview

Platform admin only: read up to 50 rows of the data a curated template opens on.

mammoth support template data-preview revenue-overview
NamePassed asRequiredDefaultTypeNotes
SLUGpositionalyes—strCurated template slug.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Up to 50 rows of the data the template opens on; capped says whether there are more.
  • Id: support.template.data-preview · Result: SupportTemplateDataPreviewResult · Backed by: SDK mammoth.api.support.SupportAPI.template_data_preview, API GET /dashboards/v3/templates/admin/{slug}/data-preview (DashboardV3AdminDataPreview)

mammoth support template discard

Platform admin only: permanently remove a curated draft, its board and its data.

mammoth support template discard revenue-overview --yes --confirm revenue-overview
NamePassed asRequiredDefaultTypeNotes
SLUGpositionalyes—strCurated template slug.
  • Effect: Destructive, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Permanently removes a curated DRAFT, its preview board and its data (if no other template shares it). Refused for a live template: unpublish or retire it instead.
  • Id: support.template.discard · Result: SupportTemplateDiscardResult · Backed by: SDK mammoth.api.support.SupportAPI.template_discard, API DELETE /dashboards/v3/templates/admin/{slug} (DashboardV3AdminDiscardImport)

mammoth support template edit

Platform admin only: edit a curated template's filing ('changes' from '--input').

mammoth support template edit revenue-overview --input '{"changes": {"name": "Status"}}' --yes --confirm revenue-overview
NamePassed asRequiredDefaultTypeNotes
SLUGpositionalyes—strCurated template slug.
changes--input fieldyes—dict[str, any]
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Edits a curated template's filing: changes holds title, description, use_case, function, industry (list) or sort_order; null clears a field. Optional base_version makes it conditional (409 when the row moved). notes says what changes for customers.
  • Id: support.template.edit · Result: SupportTemplateEditResult · Backed by: SDK mammoth.api.support.SupportAPI.template_edit, API PATCH /dashboards/v3/templates/admin/{slug} (DashboardV3AdminEditRow)

mammoth support template export

Platform admin only: download a curated template as a .zip template file.

mammoth support template export revenue-overview
NamePassed asRequiredDefaultTypeNotes
SLUGpositionalyes—strCurated template slug.
output_path--input fieldno—str | Path | None
with_data--input fieldnofalsebool
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Downloads a curated template as a .zip template file (default <slug>.zip); with_data also packages a capped copy of its rows.
  • Id: support.template.export · Result: SupportTemplateExportResult · Backed by: SDK mammoth.api.support.SupportAPI.template_export, API GET /dashboards/v3/templates/admin/{slug}/export (DashboardV3AdminExportBundle)

mammoth support template export-dashboard

Platform admin only: download a dashboard you can edit as a .zip template file.

mammoth support template export-dashboard 123 --input '{"slug": "revenue-overview"}'
NamePassed asRequiredDefaultTypeNotes
DASHBOARD_IDpositionalyes—intID of the dashboard.
slug--input fieldyes—str
output_path--input fieldno—str | Path | None
with_data--input fieldnotruebool
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Downloads a dashboard you can edit as a .zip template file; slug (required) is the id an import matches on; with_data (default true) packages a capped copy of its rows.
  • Id: support.template.export-dashboard · Result: SupportTemplateExportDashboardResult · Backed by: SDK mammoth.api.support.SupportAPI.template_export_dashboard, API GET /dashboards/v3/templates/admin/dashboards/{dashboard_id}/export (DashboardV3AdminExportDashboard)

mammoth support template import

Platform admin only: import a template file (.zip) as a curated draft. '--yes' required.

mammoth support template import template.zip --yes
NamePassed asRequiredDefaultTypeNotes
FILEpositionalyes—strPath to a local template file (.zip).
dataset--input fieldno—str
  • Effect: High impact, scope workspace · Confirmation: always --yes, even at a terminal
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Imports a template file as a curated DRAFT (not published); an existing slug is updated in place. dataset names the data to bind a file that carries none. Inspect it first.
  • Id: support.template.import · Result: SupportTemplateImportResult · Backed by: SDK mammoth.api.support.SupportAPI.template_import, API POST /dashboards/v3/templates/admin/import (DashboardV3AdminImportBundle)

mammoth support template inspect

Platform admin only: read a template file (.zip) without importing it.

mammoth support template inspect template.zip
NamePassed asRequiredDefaultTypeNotes
FILEpositionalyes—strPath to a local template file (.zip).
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Reads a template file without importing it: what it needs, whether it carries data and a picture, and whether the catalog already has it. Writes nothing. The file comes from the local disk.
  • Id: support.template.inspect · Result: SupportTemplateInspectResult · Backed by: SDK mammoth.api.support.SupportAPI.template_inspect, API POST /dashboards/v3/templates/admin/inspect (DashboardV3AdminInspectBundle)

mammoth support template list

Platform admin only: list every curated template, drafts and faults first.

mammoth support template list
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Every curated template, drafts and broken rows included, worst first, each with what is wrong and the action that fixes it.
  • Id: support.template.list · Result: SupportTemplateListResult · Backed by: SDK mammoth.api.support.SupportAPI.template_list, API GET /dashboards/v3/templates/admin (DashboardV3AdminCatalog)

mammoth support template publish

Platform admin only: take a curated draft live in every customer's gallery.

mammoth support template publish revenue-overview --yes --confirm revenue-overview
NamePassed asRequiredDefaultTypeNotes
SLUGpositionalyes—strCurated template slug.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Takes a curated draft live in every customer's gallery. Refused, with nothing published, when the template fails on its own data.
  • Id: support.template.publish · Result: SupportTemplatePublishResult · Backed by: SDK mammoth.api.support.SupportAPI.template_publish, API POST /dashboards/v3/templates/admin/{slug}/publish (DashboardV3AdminPublish)

mammoth support template retire

Platform admin only: retire a curated template (kept, no longer offered).

mammoth support template retire revenue-overview --yes --confirm revenue-overview
NamePassed asRequiredDefaultTypeNotes
SLUGpositionalyes—strCurated template slug.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Keeps the row but stops the catalog offering or auditing it; reversible with support template unpublish.
  • Id: support.template.retire · Result: SupportTemplateRetireResult · Backed by: SDK mammoth.api.support.SupportAPI.template_retire, API POST /dashboards/v3/templates/admin/{slug}/retire (DashboardV3AdminRetire)

mammoth support template snapshots

Platform admin only: list every stored dataset the template catalog holds.

mammoth support template snapshots
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Every stored dataset the template catalog holds (curated and saved templates), and the templates holding none.
  • Id: support.template.snapshots · Result: SupportTemplateSnapshotsResult · Backed by: SDK mammoth.api.support.SupportAPI.template_snapshots, API GET /dashboards/v3/templates/admin/snapshots (DashboardV3AdminSnapshots)

mammoth support template thumbnail clear

Platform admin only: remove a curated template's picture.

mammoth support template thumbnail clear revenue-overview --yes --confirm revenue-overview
NamePassed asRequiredDefaultTypeNotes
SLUGpositionalyes—strCurated template slug.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Removes a curated template's picture; its card falls back to the og-card.
  • Id: support.template.thumbnail.clear · Result: SupportTemplateThumbnailClearResult · Backed by: SDK mammoth.api.support.SupportAPI.template_thumbnail_clear, API DELETE /dashboards/v3/templates/admin/{slug}/thumbnail (DashboardV3AdminDeleteThumbnail)

mammoth support template thumbnail set

Platform admin only: upload or replace a curated template's picture from FILE.

mammoth support template thumbnail set revenue-overview card.png --yes --confirm revenue-overview
NamePassed asRequiredDefaultTypeNotes
SLUGpositionalyes—strCurated template slug.
FILEpositionalyes—strPath to a local PNG, JPEG or WebP image (1 MB at most).
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Uploads or replaces a curated template's picture: PNG, JPEG or WebP read from its content, 1 MB at most.
  • Id: support.template.thumbnail.set · Result: SupportTemplateThumbnailSetResult · Backed by: SDK mammoth.api.support.SupportAPI.template_thumbnail_set, API PUT /dashboards/v3/templates/admin/{slug}/thumbnail (DashboardV3AdminPutThumbnail)

mammoth support template unpublish

Platform admin only: take a live or retired curated template back to draft.

mammoth support template unpublish revenue-overview --yes --confirm revenue-overview
NamePassed asRequiredDefaultTypeNotes
SLUGpositionalyes—strCurated template slug.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (Mammoth staff role); refused for every other user. Returns a live or retired curated template to draft; the board, canvas and row survive.
  • Id: support.template.unpublish · Result: SupportTemplateUnpublishResult · Backed by: SDK mammoth.api.support.SupportAPI.template_unpublish, API POST /dashboards/v3/templates/admin/{slug}/unpublish (DashboardV3AdminUnpublish)

support user

mammoth support user list-all

List users across workspaces.

mammoth support user list-all
NamePassed asRequiredDefaultTypeNotes
fields--input fieldno—str
sort--input fieldno—str
offset--input fieldno—int
limit--input fieldno—int
  • Effect: Read, scope workspace · Confirmation: none
  • Id: support.user.list-all · Result: SupportUserListAllResult · Backed by: SDK mammoth.api.support.SupportAPI.user_list_all, API GET /settings/users (ListUsersOfWorkspaces)

mammoth support user register

Register a new user. Email is positional; required fields from '--input'.

mammoth support user register analyst@example.com --input '{"first_name": "Revenue report", "last_name": "Revenue report", "verified": true}' --yes --confirm analyst@example.com
NamePassed asRequiredDefaultTypeNotes
EMAILpositionalno—strEmail of the user to register; or pass it via the 'email' input field. Or the email input field.
email--input fieldno—str
first_name--input fieldyes—str
last_name--input fieldyes—str
verified--input fieldyes—bool
is_registration--input fieldno—bool
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Support staff only. Registers a new user account and may send them an invitation email. Needs --yes and --confirm TARGET.
  • Id: support.user.register · Result: SupportUserRegisterResult · Backed by: SDK mammoth.api.support.SupportAPI.user_register, API POST /support/users (RegisterUser)

mammoth support user update

Update a user's verification status. Email is positional.

mammoth support user update analyst@example.com --input '{"verified": true}' --yes --confirm analyst@example.com
NamePassed asRequiredDefaultTypeNotes
EMAILpositionalno—strEmail of the user to update; or pass it via the 'email' input field. Or the email input field.
email--input fieldno—str
verified--input fieldyes—bool
is_registration--input fieldno—bool
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Support staff only. Changes another user's account details. Needs --yes and --confirm TARGET.
  • Id: support.user.update · Result: SupportUserUpdateResult · Backed by: SDK mammoth.api.support.SupportAPI.user_update, API PATCH /support/users (UpdateUserVerification)

support workspace

mammoth support workspace activity

List a workspace's activity log.

mammoth support workspace activity 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: WORKSPACE_ID.
  • Id: support.workspace.activity · Result: SupportWorkspaceActivityResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_activity, API GET /support/workspaces/{workspace_id}/activity (SupportWorkspaceActivity)

mammoth support workspace archive

Archive a workspace to cold storage. confirm_name must be the workspace's name.

mammoth support workspace archive 123 --input '{"storage_class": "GLACIER_IR", "confirm_name": "Revenue report", "reason": "Customer left"}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
storage_class--input fieldyes—str
confirm_name--input fieldyes—str
reason--input fieldno—str
cancel_billing--input fieldnofalsebool
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it) · Waits: returns a job id at once; follow it with mammoth job wait
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Moves the workspace's data to cold storage and takes it offline. The server answers 202 and queues a job: poll support workspace archive-info WORKSPACE_ID until the archive has finished. Needs storage_class (GLACIER_IR or DEEP_ARCHIVE) and confirm_name, the workspace's exact name (case sensitive). cancel_billing also cancels billing. Read support workspace archive-info WORKSPACE_ID first. Reverse it with support workspace restore-archive WORKSPACE_ID.
  • Id: support.workspace.archive · Result: SupportWorkspaceArchiveResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_archive, API POST /support/workspaces/{workspace_id}/archive (SupportWorkspaceArchive)

mammoth support workspace archive-info

Show what archiving a workspace would do, and its archive state.

mammoth support workspace archive-info 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: WORKSPACE_ID.
  • Id: support.workspace.archive-info · Result: SupportWorkspaceArchiveInfoResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_archive_info, API GET /support/workspaces/{workspace_id}/archive (SupportWorkspaceArchiveInfo)

mammoth support workspace chargebee-cancelled

Record a workspace's Chargebee subscription as cancelled. Workspace id is positional.

mammoth support workspace chargebee-cancelled 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Records the workspace's Chargebee subscription as cancelled; use it only after the cancellation was done in Chargebee.
  • Id: support.workspace.chargebee-cancelled · Result: SupportWorkspaceChargebeeCancelledResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_chargebee_cancelled, API POST /support/workspaces/{workspace_id}/chargebee-cancelled (SupportWorkspaceChargebeeCancelled)

mammoth support workspace create

Create a workspace. Name is positional; required fields from '--input'.

mammoth support workspace create 'Revenue report' --input '{"user_email": "analyst@example.com", "payment_frequency": "monthly"}' --yes --confirm 'Revenue report'
NamePassed asRequiredDefaultTypeNotes
NAMEpositionalno—strName of the new workspace; or pass it via the 'name' input field. Or the name input field.
name--input fieldno—str
user_email--input fieldyes—str
payment_frequency--input fieldyes—str
plan_id--input fieldno—int
origin--input fieldno—str
is_verified--input fieldnotruebool
is_registration--input fieldnofalsebool
file_id--input fieldno—str
table_number--input fieldno—int
plan_create--input fieldno—dict[str, any]
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Support staff only. Creates a workspace with its owner and plan (payment_frequency monthly or yearly). Needs --yes and --confirm TARGET.
  • Id: support.workspace.create · Result: SupportWorkspaceCreateResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_create, API POST /support/workspaces (CreateWorkspaces)

mammoth support workspace deal-seed

Show the deal terms a workspace's current subscription would seed.

mammoth support workspace deal-seed 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: WORKSPACE_ID.
  • Id: support.workspace.deal-seed · Result: SupportWorkspaceDealSeedResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_deal_seed, API GET /support/workspaces/{workspace_id}/deal-seed (SupportWorkspaceDealSeed)

mammoth support workspace delete

Delete one workspace by id.

mammoth support workspace delete 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: WORKSPACE_ID.
  • Id: support.workspace.delete · Result: SupportWorkspaceDeleteResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_delete, API DELETE /support/workspaces/{workspace_id} (DeleteWorkspace)

mammoth support workspace entitlement

Show the entitlements a workspace resolves to.

mammoth support workspace entitlement 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: WORKSPACE_ID.
  • Id: support.workspace.entitlement · Result: SupportWorkspaceEntitlementResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_entitlement, API GET /support/workspaces/{workspace_id}/entitlement (SupportWorkspaceEntitlement)

mammoth support workspace get

Get details of a workspace. Workspace id is positional.

mammoth support workspace get 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
fields--input fieldno—str
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Required inputs: WORKSPACE_ID.
  • Id: support.workspace.get · Result: SupportWorkspaceGetResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_get, API GET /support/workspaces/{workspace_id} (GetWorkspaceDetail)

mammoth support workspace invite cancel

Cancel a pending workspace invite. Workspace id and invite id are positional.

mammoth support workspace invite cancel 123 456 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
INVITE_IDpositionalyes—intID of the invite.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Cancels the pending invite so its link stops working.
  • Id: support.workspace.invite.cancel · Result: SupportWorkspaceInviteCancelResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_invite_cancel, API DELETE /support/workspaces/{workspace_id}/users/invites/{invite_id} (SupportCancelWorkspaceInvite)

mammoth support workspace invite resend

Resend a pending workspace invite. Workspace id and invite id are positional.

mammoth support workspace invite resend 123 456 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
INVITE_IDpositionalyes—intID of the invite.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Emails the invitee again at once.
  • Id: support.workspace.invite.resend · Result: SupportWorkspaceInviteResendResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_invite_resend, API POST /support/workspaces/{workspace_id}/users/invites/{invite_id}/resend (SupportResendWorkspaceInvite)

mammoth support workspace list

List all workspaces visible to the current admin/support user.

mammoth support workspace list
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Id: support.workspace.list · Result: SupportWorkspaceListResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_list, API GET /support/workspaces (ListWorkspaces)

mammoth support workspace project list

List a workspace's projects with their unfinished project moves.

mammoth support workspace project list 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Tech admin only (Mammoth staff role); refused for every other user.
  • Id: support.workspace.project.list · Result: SupportWorkspaceProjectListResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_project_list, API GET /support/workspaces/{workspace_id}/projects (ListProjects)

mammoth support workspace project move-check

Check, read-only, moving a project to another workspace.

mammoth support workspace project move-check 123 456 --input '{"target_workspace_id": 1}'
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
PROJECT_IDpositionalyes—intID of the project.
target_workspace_id--input fieldyes—int
  • Effect: Read, scope workspace · Confirmation: none
  • Preconditions: Tech admin only (Mammoth staff role); refused for every other user. Pass the workspace the project is in and the project id as positionals and target_workspace_id in --input.
  • Id: support.workspace.project.move-check · Result: SupportWorkspaceProjectMoveCheckResult · Backed by: SDK mammoth.api.support.SupportAPI.project_move_check, API GET /support/workspaces/{workspace_id}/projects/{project_id}/move (CheckProjectMove)

mammoth support workspace project move-start

Start moving a project to another workspace, or resume its unfinished move.

mammoth support workspace project move-start 123 456 --input '{"target_workspace_id": 1}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
PROJECT_IDpositionalyes—intID of the project.
target_workspace_id--input fieldyes—int
acknowledged_warnings--input fieldno—list[str]
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Tech admin only (Mammoth staff role); refused for every other user. Run support workspace project move-check first; acknowledged_warnings must hold the code of every warning. A project with an unfinished move resumes that move.
  • Id: support.workspace.project.move-start · Result: SupportWorkspaceProjectMoveStartResult · Backed by: SDK mammoth.api.support.SupportAPI.project_move_start, API POST /support/workspaces/{workspace_id}/projects/{project_id}/move (StartProjectMove)

mammoth support workspace restore-access

Restore user access to a suspended workspace. Workspace id is positional.

mammoth support workspace restore-access 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: WORKSPACE_ID.
  • Id: support.workspace.restore-access · Result: SupportWorkspaceRestoreAccessResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_restore_access, API POST /support/workspaces/{workspace_id}/restore-access (RestoreWorkspaceAccess)

mammoth support workspace restore-archive

Restore an archived workspace from cold storage. Workspace id is positional.

mammoth support workspace restore-archive 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it) · Waits: returns a job id at once; follow it with mammoth job wait
  • Preconditions: Platform admin only (super or tech admin); a sales admin can read but not write. Brings an archived workspace back from cold storage. The server answers 202 and queues a job: poll support workspace archive-info WORKSPACE_ID until the restore has finished. Check support workspace archive-info WORKSPACE_ID first.
  • Id: support.workspace.restore-archive · Result: SupportWorkspaceRestoreArchiveResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_restore_archive, API POST /support/workspaces/{workspace_id}/restore (SupportWorkspaceArchiveRestore)

mammoth support workspace suspend-access

Suspend user access to a workspace. Workspace id is positional.

mammoth support workspace suspend-access 123 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
reason--input fieldno—str
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: WORKSPACE_ID.
  • Id: support.workspace.suspend-access · Result: SupportWorkspaceSuspendAccessResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_suspend_access, API POST /support/workspaces/{workspace_id}/suspend-access (SuspendWorkspaceAccess)

mammoth support workspace update

Update a workspace's details/subscription. Workspace id is positional.

mammoth support workspace update 123 --input '{"name": "Revenue report", "payment_frequency": "monthly", "plan_id": 1}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
name--input fieldyes—str
payment_frequency--input fieldyes—str
plan_id--input fieldyes—int
plan_create--input fieldno—dict[str, any]
plan_update--input fieldno—dict[str, any]
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: WORKSPACE_ID.
  • Id: support.workspace.update · Result: SupportWorkspaceUpdateResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_update, API PATCH /support/workspaces/{workspace_id} (UpdateWorkspaceDetail)

mammoth support workspace user add

Add a user to a workspace. Workspace id is positional.

mammoth support workspace user add 123 --input '{"email": "analyst@example.com", "role": "workspace_member"}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
email--input fieldyes—str
role--input fieldyes—str
first_name--input fieldno—str
last_name--input fieldno—str
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: WORKSPACE_ID.
  • Id: support.workspace.user.add · Result: SupportWorkspaceUserAddResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_user_add, API POST /support/workspaces/{workspace_id}/users (AddUserToWorkspace)

mammoth support workspace user list

List users in a workspace. Workspace id is positional.

mammoth support workspace user list 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
limit--input fieldno—int
offset--input fieldno—int
fields--input fieldno—str
sort--input fieldno—str
  • Effect: Read, scope workspace · Confirmation: none · Pages: single_page
  • Preconditions: Required inputs: WORKSPACE_ID.
  • Id: support.workspace.user.list · Result: SupportWorkspaceUserListResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_user_list, API GET /support/workspaces/{workspace_id}/users (GetUserList)

mammoth support workspace user remove

Remove a user from a workspace. Workspace id is positional.

mammoth support workspace user remove 123 456 --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
USER_IDpositionalyes—intID of the user.
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: WORKSPACE_ID, USER_ID.
  • Id: support.workspace.user.remove · Result: SupportWorkspaceUserRemoveResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_user_remove, API DELETE /support/workspaces/{workspace_id}/users/{user_id} (RemoveWorkspaceUser)

mammoth support workspace user transfer

Transfer/change a user's role within a workspace. Workspace id is positional.

mammoth support workspace user transfer 123 456 --input '{"role": "workspace_admin"}' --yes --confirm 123
NamePassed asRequiredDefaultTypeNotes
WORKSPACE_IDpositionalyes—intID of the workspace.
USER_IDpositionalyes—intID of the user.
role--input fieldyes—str
remove_role--input fieldno—str
  • Effect: High impact, scope workspace · Confirmation: always --yes --confirm TARGET, even at a terminal (TARGET is the exact id or name acted on; the confirmation_required error's hint names it)
  • Preconditions: Required inputs: WORKSPACE_ID, USER_ID.
  • Id: support.workspace.user.transfer · Result: SupportWorkspaceUserTransferResult · Backed by: SDK mammoth.api.support.SupportAPI.workspace_user_transfer, API PATCH /support/workspaces/{workspace_id}/users (TransferUserRoles)

Report an issue · support@mammoth.io