v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB

Management

Update Custom Event Schema

Updates a custom event schema.

With this request, you can:

Add a nonexistent property to a custom event schema.
Update an existing property.

In the request, you can provide only those properties you want to add or update. Definitions omitted in the request remain unchanged.

👍 Additional Notes

You can change the type of an existing property, e.g. from "string" to "number".

You can remove a custom property with this endpoint by providing "deleted": true in the request. However, you cannot permanently remove an event definition or its property with this endpoint.

📘 Custom Event Documentation

Read Custom Events article to learn how custom events work in Voucherify.

Read also the details about the Track Custom Event endpoint and the Custom Event Object.

put/management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId}

Request body

Response

Returns the details about the updated custom event schema.

idstring required

Unique identifier of the custom event schema.

namestring required

User-defined name of the custom event. This is also shown in Project Settings > Event Schema in the Voucherify Dashboard.

created_atstring date-time required

Timestamp representing the date and time when the custom event schema was created. The value is shown in the ISO 8601 format.

updated_atstring date-time

Timestamp representing the date and time when the custom event schema was updated. The value is shown in the ISO 8601 format.

object'custom-event-schema' required

The type of the object represented by JSON.

Example response

{
  "id": "ms_oA8CawM07Q8i05Cx62U6euTK",
  "created_at": "2024-03-27T08:00:09.472Z",
  "updated_at": "2024-03-27T08:00:09.472Z",
  "object": "custom-event-schema"
}