Skip to main content
POST
Create Custom Transform Activity

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Organization-Id
string | null

Path Parameters

catalog_id
string
required

Body

application/json

Request to create a custom transform activity with full audit metadata

activity_message
string
required

Human-readable description (e.g., 'Q2 price update')

script
Script · object | null

Transform script metadata: {filename, content, sha256}

diff_summary
Diff Summary · object | null

Diff summary: {rows_before, rows_after, rows_added, rows_removed, rows_modified, ...}

validation_report
Validation Report · object | null

Bundle validation report

staged_changes
PublicStagedChangeInput · object[]

Staged changes

schema_changes
Schema Changes · object | null

Schema changes to apply alongside row changes

taxonomy_changes
Taxonomy Changes · object | null

Taxonomy changes to apply alongside row changes

attachments
Attachments · object[] | null

Optional attachment metadata used in this session (files, urls, sheet names)

activity_context
Activity Context · object | null

Optional activity context for auditability (tool params, notes, attachment refs, etc.)

session_context
Session Context · object | null

Deprecated alias for activity_context.session_context

base_snapshot_id
string | null

Optional snapshot ID for audit trail

Response

Successful Response

Response after creating a custom transform activity

activity_id
string
required
status
string
required
staged_count
integer
required
review_url
string
required