Update Event

Update event description and its linked schema.

PATCH /v1/{workspace}/event/{url_encoded_event_name}

Update Event

cURL

curl -X POST "https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/" \
  --header 'Authorization: ServiceToken <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "Triggered whenever a new user successfully signs up on the platform",
    "payload_schema": {
      "schema": "user_signup_v1"
    }
  }'

200

{
  "name": "user_signup",
  "description": "Triggered whenever a new user successfully signs up on the platform",
  "payload_schema": {
    "schema": "user_signup_v1",
    "version_no": 1
  },
  "created_at": "2025-08-27T09:30:57.945326Z",
  "$schema": "https://schema.suprsend.com/event/v1/schema.json"
}

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.)

url_encoded_event_name · string · required

URL encoded event name

Body

application/json

description · string

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

Example:

"Triggered whenever a new user successfully signs up on the platform"

payload_schema · object

Show child attributes

Response

200

application/json

Updated event details

The response is of type object.