PATCH
/
v1
/
{workspace}
/
event
/
{url_encoded_event_name}
/
cURL
curl -X POST "https://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"
    }
  }'
{
  "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"
}
Update event description and its linked schema. Creating events beforehand helps users to know the event structure and their associated variables during test runs and can help reduce variable mismatch errors during runtime.

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

Response

200
application/json

Updated event details

The response is of type object.