Skip to main content
PATCH
/
v1
/
{workspace}
/
event
/
{url_encoded_event_name}
/
Update Event
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"
    }
  }'
import requests

url = "https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/"

payload = {
"description": "Triggered whenever a new user successfully signs up on the platform",
"payload_schema": { "schema": "user_signup_v1" }
}
headers = {
"ServiceToken <token>": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'ServiceToken <token>': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'Triggered whenever a new user successfully signs up on the platform',
payload_schema: {schema: 'user_signup_v1'}
})
};

fetch('https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'Triggered whenever a new user successfully signs up on the platform',
'payload_schema' => [
'schema' => 'user_signup_v1'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"ServiceToken <token>: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/"

payload := strings.NewReader("{\n \"description\": \"Triggered whenever a new user successfully signs up on the platform\",\n \"payload_schema\": {\n \"schema\": \"user_signup_v1\"\n }\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("ServiceToken <token>", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/")
.header("ServiceToken <token>", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Triggered whenever a new user successfully signs up on the platform\",\n \"payload_schema\": {\n \"schema\": \"user_signup_v1\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["ServiceToken <token>"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Triggered whenever a new user successfully signs up on the platform\",\n \"payload_schema\": {\n \"schema\": \"user_signup_v1\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "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"
}
{
"code": 400,
"error_code": "error",
"type": "ValidationError",
"message": "{\"payload_schema\": [\"Schema is required\"]}",
"detail": {
"payload_schema": [
"Schema is required"
]
}
}
{
"code": 401,
"error_code": "authentication_failed",
"type": "AuthenticationFailed",
"message": "Invalid service token.",
"detail": "Invalid service token."
}

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

Response

Updated event details

The response is of type object.