For the complete documentation index, see llms-docs.txt or the site index llms.txt. Full docs corpus: llms-full-docs.txt. Prefer the markdown version of this page at /docs/api/workflow/events/patch-api-workflow-v1events-by-event_id.md. Product capabilities: skill.md. Docs MCP: /docs/mcp. Site MCP: /mcp.
Update event
PATCH
/api/workflow/v1/events/:event_id
1import { Reloop } from "reloop-email";2
3const reloop = new Reloop({ apiKey: "rl_123456789" });4
5const { event, eventError } = await reloop.events.update("evt_123456789", {6 description: "Fired when an account is created",7 properties: [{ name: "plan", propertyType: "string", required: true }],8});9if (eventError) throw eventError;1{2 "id": "evt_123456789",3 "organizationId": "org_123456789",4 "name": "User signed up",5 "key": "trigger.user.signed_up",6 "description": "Fired when an account is created",7 "properties": [8 {9 "id": "evtp_123456789",10 "name": "plan",11 "propertyType": "string",12 "required": true,13 "defaultValue": null,14 "description": "The plan they picked",15 "createdAt": "2026-03-23T10:00:00.000Z",16 "updatedAt": "2026-03-23T10:00:00.000Z"17 }18 ],19 "createdAt": "2026-03-23T10:00:00.000Z",20 "updatedAt": "2026-03-23T10:00:00.000Z"21}Path Parameters
event_idstringRequired
- Minimum length:
1
Body Parameters
namestring
Display name
- Minimum length:
1 - Maximum length:
255
descriptionstring | null
Description, or null to clear it
propertiesobject[]
Replaces every property
Custom properties
namestringRequired
Property key in the track payload
- Minimum length:
1 - Maximum length:
128
propertyType"string" | "number" | "boolean"
Possible values: string | number | boolean
requiredboolean
Tracking without it fails. Defaults to false.
defaultValuestring | null
Used when tracking leaves the property out
descriptionstring | null
Was this page helpful?