HomeGuidesAPI Reference
Need Help?
API Reference
Need Help?

Create custom event metadata

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

Declares a new brand-custom event schema. The event identity is the
combination of name and origin; displayName and at least one
top-level property are required. Optional metadata fields must be
omitted rather than sent as null. The created event is returned with
every node flagged explicitlyDefined.

Scopes:
events.write

Rate Limiting:
This endpoint is rate limited to 400 requests per minute.

Body Params

Event schema to create

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-03-15

API version that specifies the response format and behaviour

Responses

Updated 1 day 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 1 day ago

Did this page help you?