Workspaces Support

Create new workspace

Create new workspace including relevant details.

post/support/workspaces

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/support/workspaces
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Request body

namestring required

Name of the workspace to be created

user_emailstring email required

Email of the customer

plan_idinteger nullable

Plan ID

payment_frequencystring required

Payment frequency of the workspace

storage_gbinteger nullable

Chosen TOTAL storage allocation in GB for the subscription

originstring nullable

Origin of the request

templatestring nullable

Public-gallery template slug the sign-up came for

anon_distinct_idstring nullable

Visitor's PostHog anonymous distinct id at signup

landing_urlstring nullable

Visitor's first-touch landing page URL

referring_domainstring nullable

Visitor's first-touch referring domain

utm_sourcestring nullable

Visitor's first-touch utm_source

utm_mediumstring nullable

Visitor's first-touch utm_medium

utm_campaignstring nullable

Visitor's first-touch utm_campaign

gclidstring nullable

Visitor's first-touch Google Ads click id

current_urlstring nullable

The page the visitor was on at the moment of signing up

signup_channel'cli' | 'mcp' | 'web'

Where the sign-up started: cli, mcp or web (default)

is_verifiedboolean

Is verified

is_registrationboolean

Is registration

file_idstring nullable

File ID of the file

table_numberinteger[] nullable

Table number of the file

Example request

{
  "name": "Docs",
  "plan_id": 1,
  "user_email": "test@test.com",
  "payment_frequency": "monthly",
  "is_verified": true
}

Response

Successful create

idinteger required
status'success' | 'failure' | 'processing' | 'error' required

Job status can be success, failure or processing

responseobject required

Result of async task is stored in response

last_updated_atstring date-time required

Job last updated at is the time when Job status was last updated

created_atstring date-time required

Create at is time when async task was created

pathstring required

API request path of the Job operation

operationstring required

Operation is async task name which Job is tracking

Example response

{
  "response": {
    "value": {
      "response": {
        "object": "some object"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.