Workflow Templates

Update a workflow template

Update template fields.

patch/workspaces/{workspace_id}/templates/{template_id}

Request

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

Request body

namestring nullable
descriptionstring nullable
status'draft' | 'blueprint' | 'ready'

Lifecycle status of a workflow template.

save_preset'keep-all' | 'structure-only' | 'empty'

How to handle data when instantiating a template.

template_dataobject nullable
endpoint_layersobject nullable
visibility'private' | 'project' | 'organization'

Visibility scope: private | project | organization

Response

Request fulfilled, document follows

idinteger required
workspace_idinteger required
namestring required
descriptionstring nullable
statusstring nullable
save_presetstring nullable
template_dataobject nullable
endpoint_layersobject nullable
visibilitystring nullable
created_byinteger nullable
created_atstring nullable
updated_atstring nullable

Changes

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