Update an event

Replace an event's properties.

PATCHhttps://app.usenotix.dev/api/v1/events/definitions/{idOrName}

Needs a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.

Replace an event's properties. The name does not change. Needs a full access key made by a team admin (403 otherwise). Any key but a sending-only one can read events.

Path parameters

idOrNamestringrequired

Body parameters

propertiesobject[]
properties[].namestringrequired
properties[].typestringrequired

One of text, number, date, boolean, string, bool.

schemamap of string

Resend's form of properties: { "plan": "string" }.

Headers

Authorizationstringrequired

Bearer followed by your API key.

Errors

400

A property is not valid.

403

The key is not a full access key made by a team admin.

404

No event with this id or name for the calling team.

Every error has the same shape. See all error codes.

curl -X PATCH "https://app.usenotix.dev/api/v1/events/definitions/<idOrName>" \
  -H "Authorization: Bearer $NOTIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "properties": [
    {
      "name": "Acme",
      "type": "text"
    }
  ],
  "schema": {
    "plan": "string"
  }
}'
Response200
{
  "id": "cm1x8f3k20001qz7v5b9d2e4a",
  "name": "Acme",
  "properties": [
    {
      "name": "Acme",
      "type": "text"
    }
  ],
  "createdAt": "2026-10-01T09:00:00Z",
  "updatedAt": "2026-10-01T09:00:00Z"
}
Open in ClaudeOpen in ChatGPT