HomeGuidesAPI Reference
Need Help?
API Reference
Need Help?

Update custom event metadata

put
https://api.omnisend.com/api/event-metadata

Merges changes into an existing brand-custom event, identified by
name and origin. Only supplied fields are applied: omitted
metadata and omitted properties are preserved, and no property is
deleted. The type of an already explicitly-defined property cannot
change. Optional metadata fields must be omitted rather than sent as
null. The merged event is returned.

Body Params

Event schema changes to merge

Request body for creating (POST) or merging (PUT) a brand-custom event-metadata schema. Optional metadata fields are pointers so PUT can distinguish an omitted field (preserve the stored value) from one explicitly set to an empty string.

string

Human-readable label. Required on POST; omit on PUT to keep the stored value.

string
required

Machine-readable event name

string
required

Single origin the schema belongs to

properties
object

Property tree keyed by property name. Required with at least one key on POST;
on PUT only the keys present are merged.

Headers
string
required
Defaults to 2026-preview

API version that specifies the response format and behaviour

Responses

Updated 3 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago

Did this page help you?