Skip to main content
PATCH
/
v1
/
{workspace}
/
schema
/
{schema_slug}
/
commit
Commit Schema
curl -X PATCH "https://management-api.suprsend.com/v1/{workspace}/schema/{schema_slug}/commit/" \
  --header 'Authorization: ServiceToken <token>' \
  --header 'Content-Type: application/json'
{
  "slug": "new-order-placed",
  "name": "Order Placed Event",
  "description": "Schema for order placement action",
  "status": "live",
  "hash": "382b707d4b1f8999a1xxxxxxxx",
  "json_schema": {
    "type": "object",
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "required": [
      "order_id",
      "amount"
    ],
    "properties": {
      "order_id": {
        "type": "string"
      },
      "amount": {
        "type": "string"
      }
    },
    "additionalProperties": true
  },
  "created_at": "2025-08-27T09:30:57.945326Z",
  "updated_at": "2025-08-29T15:37:37.650177Z",
  "committed_at": "2025-09-01T18:35:00.270698Z",
  "commit_message": "required fields updated"
}

Authorizations

​
ServiceToken <token>
string
header
required

You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.

Path Parameters

​
workspace
string
required

Workspace slug (staging, production, etc.)

​
schema_slug
string
required

Unique identifier of the schema

Query Parameters

​
commit_message
string

Commit message describing the changes

Response

Successfully retrieved schema object

​
slug
string

Unique identifier for the schema

Example:

"new-order-placed"

​
name
string

Human-readable name of the schema

Example:

"Order Placed Event"

​
description
string | null

Description of the schema. Can be used to describe which action this schema is linked to.

Example:

"Schema for order placement action"

​
status
enum<string>

Status of returned schema. By default, draft version is returned. You can set mode=live to fetch the live schema.

Available options:
draft,
live
Example:

"live"

​
hash
string

Git-like hash for version tracking

Example:

"382b707d4b1f8999a1xxxxxxxx"

​
json_schema
object

updated json schema

​
created_at
string<date-time>

When the schema was created

Example:

"2025-08-27T09:30:57.945326Z"

​
updated_at
string<date-time>

When the schema was last updated

Example:

"2025-08-29T15:37:37.650177Z"

​
committed_at
string<date-time>

When the schema was last committed

Example:

"2025-09-01T18:35:00.270698Z"

​
commit_message
string

Last commit message

Example:

"required fields updated"