Parameters

Create parameter

Create a new parameter

post/workspaces/{workspace_id}/parameters

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/workspaces/{workspace_id}/parameters
  • 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

Path parameters

workspace_idinteger required

Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

Example:4

Request body

namestring required

Parameter name

param_typestring required

Parameter type (NUMERIC, TEXT, DATE)

descriptionstring nullable
group_idinteger nullable
scopestring
project_idinteger nullable

Required when scope='project'

Example request

{
  "name": "start_date",
  "value": "2026-01-01",
  "param_type": "DATE",
  "description": "Start date for reports",
  "scope": "project",
  "project_id": 1
}

Response

Create workspace parameter

idinteger required
namestring required
param_typestring required
descriptionstring nullable
scopestring required
group_idinteger nullable
group_namestring nullable
pipeline_countinteger required
stale_pipelinesinteger[]
created_byinteger required
created_atstring required
updated_byinteger nullable
updated_atstring required

Changes

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