Sample Flow

Trigger sample-flow import

Downloads the public sample CSV, creates a future request, and enqueues an async job to ingest it.

post/workspaces/{workspace_id}/projects/{project_id}/sample-flow

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/workspaces/{workspace_id}/projects/{project_id}/sample-flow
  • 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
project_idinteger required

Project ID of the workspace

Example:4

Request body

label_resource_idinteger nullable

Optional parent label/folder resource to place the imported file under.

Example request

{
  "label_resource_id": 123
}

Response

Sample flow request accepted

namestring required

Name of the downloaded sample file.

job_idinteger required

ID of the created async job for ingesting the sample file.

Changes

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