Skip to main content
POST
Create Activity With Staged Changes

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 an activity with staged changes

type
string
default:smart_import

Activity type (e.g., smart_import, custom_transform)

description
string | null

Human-readable description of the activity

input_data
Input Data · object | null

Optional full activity input data for audit context and apply-time hooks

staged_changes
PublicStagedChangeInput · object[]

Staged changes to attach to the activity

metadata
Metadata · object | null
status
string | null

Initial activity status (defaults to 'pending_review' if staged_changes provided, else 'created')

Response

Successful Response

Response after creating an activity

activity_id
string
required
status
string
required
staged_changes_count
integer
required