Push Schema

Upload local schema JSON files to a workspace. Reads <slug>/schema.json and <slug>/payload_schema.json from the input directory and pushes them. By default, changes are staged as drafts. Use --commit to also promote to live. Pass a slug as a positional argument or via --slug to push a single schema.
Any schema that fails validation will be skipped and not pushed to the workspace.

Syntax

suprsend schema push [<slug>] [flags]

Options

Flag	Description	Default
`-h, --help`	Show help for the command	–
`-c, --commit`	Promote changes from draft to live after pushing	`false`
`--commit-message string`	Message describing the changes being committed	–
`-d, --dir string`	Directory containing schema subdirectories	`./suprsend/schemas`
`-g, --slug string`	Schema slug to push (omit to push all)	–
`-j, --json string`	Schema definition as a JSON object (requires `--slug`). Must be a valid JSON Schema object	–
`-n, --dry-run`	Print what would be pushed without making any changes	–
`-F, --force`	Skip confirmation prompt when `--commit` is set	–

Example

# Push schemas to staging workspace (default)
suprsend schema push

# Push schemas to production workspace
suprsend schema push --workspace production

# Push individual schema by passing it's slug
suprsend schema push --slug my-schema

# Push schemas and commit them
suprsend schema push --commit --commit-message "Commit message"

# Push a single schema inline via JSON
suprsend schema push --slug order-payload --json '{"type":"object","properties":{"key":{"type":"string"}}}'

🚨 Push and Commit Behavior:

Schemas not showing up in live mode? → Check if they’re linked to workflows
Fix: Update your workflow files to include the new schemas, or remove the workflow links

Getting Started with CLI

Updates and Versioning

Sync

Workflow

Template

Schema

Event

Preference Category

Translation

Syntax

Options

Example

​Syntax

​Options

​Example

Syntax

Options

Example