Skip to main content

Update Event

PATCH/v2/project/{project_key}/event/{event_id}

Update fields on a single event. Only the fields you include are changed — all other fields remain unchanged.

Path parameters

ParameterDescription
project_keyYour project's API key
event_idThe numeric event ID

Updatable fields

FieldTypeDescription
event_textstringRename the event
event_propertyobject or stringReplace the event's metadata
urlstringUpdate the associated page URL
event_pathstringUpdate the associated URL path
sessionstringUpdate the session identifier
statusinteger1 = active, 2 = soft-delete

Example: rename an event

curl -X PATCH "https://api-{region}.mida.so/v2/project/YOUR_PROJECT_KEY/event/9876" \
-H "Authorization: Bearer YOUR_GENERATED_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"event_text": "Pricing CTA Clicked — Mobile"
}'

Example: update event metadata

curl -X PATCH "https://api-{region}.mida.so/v2/project/YOUR_PROJECT_KEY/event/9876" \
-H "Authorization: Bearer YOUR_GENERATED_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"event_property": {"device": "mobile", "button_id": "hero-cta"}
}'

Success response

{
"success": true,
"event_id": 9876
}

Error responses

StatusMeaning
400Invalid field values or malformed request body
401Invalid or missing API key
404Event not found or belongs to a different project