---
title: "Update event"
full: true
_openapi:
  method: PATCH
  toc: []
  structuredData:
    headings: []
    contents:
      - content: "Updates name/description and optionally replaces the property schema"
_apiData:
  document: "https://reloop.sh/api/workflow/openapi/json"
  operationData: [{"path":"/api/workflow/v1/events/{event_id}","method":"patch"}]
  parameterList: [{"name":"event_id","type":"string","required":true,"description":"","location":"path","minLength":1},{"name":"name","type":"string","required":false,"description":"Display name","location":"body","minLength":1,"maxLength":255},{"name":"description","type":"string | null","required":false,"description":"Description, or null to clear it","location":"body"},{"name":"properties","type":"object[]","required":false,"description":"Replaces every property","location":"body","properties":[{"name":"name","type":"string","required":true,"description":"Property key in the track payload","location":"body","minLength":1,"maxLength":128,"pattern":"^[a-zA-Z][a-zA-Z0-9_]*$"},{"name":"propertyType","type":"\"string\" | \"number\" | \"boolean\"","required":false,"description":"","location":"body","enumValues":["string","number","boolean"]},{"name":"required","type":"boolean","required":false,"description":"Tracking without it fails. Defaults to false.","location":"body"},{"name":"defaultValue","type":"string | null","required":false,"description":"Used when tracking leaves the property out","location":"body"},{"name":"description","type":"string | null","required":false,"description":"","location":"body"}]}]
  responseMap: {"200":{"description":"Response for status 200","schema":{"id":"evt_123456789","organizationId":"org_123456789","name":"User signed up","key":"trigger.user.signed_up","description":"Fired when an account is created","properties":[{"id":"evtp_123456789","name":"plan","propertyType":"string","required":true,"defaultValue":null,"description":"The plan they picked","createdAt":"2026-03-23T10:00:00.000Z","updatedAt":"2026-03-23T10:00:00.000Z"}],"createdAt":"2026-03-23T10:00:00.000Z","updatedAt":"2026-03-23T10:00:00.000Z"}},"400":{"description":"Response for status 400","schema":{"message":"Invalid event properties","why":"Missing required property \"plan\".","fix":"Fix property names/types and try again."}},"401":{"description":"Response for status 401","schema":{"message":"Authentication required"}},"404":{"description":"Response for status 404","schema":{"message":"Event not found","why":"No custom event \"trigger.user.signed_up\" exists for your organization.","fix":"Create the event first, or verify the key / ID."}},"500":{"description":"Response for status 500","schema":{"message":"Failed to update event","why":"An unexpected error occurred while updating the event.","fix":"Please try again later."}}}
  codeSamples:
    - id: node
      lang: javascript
      label: Node.js
      source: |-
        import { Reloop } from "reloop-email";
        
        const reloop = new Reloop({ apiKey: "rl_123456789" });
        
        const { event, eventError } = await reloop.events.update("evt_123456789", {
          description: "Fired when an account is created",
          properties: [{ name: "plan", propertyType: "string", required: true }],
        });
        if (eventError) throw eventError;
    - id: curl
      lang: bash
      label: cURL
      source: |-
        curl -X PATCH https://reloop.sh/api/workflow/v1/events/evt_123456789 \
          -H "x-api-key: rl_123456789" \
          -H "Content-Type: application/json" \
          -d '{"description":"Fired when an account is created","properties":[{"name":"plan","propertyType":"string","required":true}]}'
    - id: python
      lang: python
      label: Python
      source: |-
        import requests
        
        res = requests.patch(
            "https://reloop.sh/api/workflow/v1/events/evt_123456789",
            headers={"x-api-key": "rl_123456789"},
            json={
                "description": "Fired when an account is created",
                "properties": [
                    {
                        "name": "plan",
                        "propertyType": "string",
                        "required": True
                    }
                ]
            },
        )
        res.raise_for_status()
        print(res.json())
---
> For the complete documentation index, see [llms-docs.txt](/llms-docs.txt) or the site index [llms.txt](/llms.txt). Full docs corpus: [llms-full-docs.txt](/llms-full-docs.txt). Prefer markdown URLs (append `.md`) for agent consumption. Product skill: [skill.md](/skill.md).


{/* This file was generated by the OpenAPI doc generator. Do not edit this file directly. Run `bun run generate:api-docs` to regenerate. */}

<APIPage />