put
https://{app-url}{}/api/v2/user-events
Use this API to edit an existing event. Provide the event ID along with the updated event details, using the same request structure as the Add Event API.
| Argument | Description |
|---|---|
| id | Event ID. |
| Title | Required. Event title. |
| Description | (Optional) Description of the event. |
| Category | Required. Name of the predefined category to which the event belongs (e.g., deployments, marketing_campaigns, holidays). If the required category does not exist, create one using the Create Event Category API. |
| Source | Required. Predefined source of the event (e.g., rest_api, Chef, Jenkins). If the required source does not exist, create one using the Create Event Source API. |
| Properties | (Optional) Additional event metadata represented as key-value pairs. Do not include fields already defined as request arguments, such as title, description, or category. Examples: severity: high, publisher: nyt, exchange: rubicon. |
| startDate | Required. Event start time as a Unix epoch timestamp in seconds. |
| endDate | (Optional) Event end time as a Unix epoch timestamp in seconds. |
| Type | (Optional) Event type. Possible values: DISPLAY – display the event only; INFLUENCE – use the event for event correlation; SUPPRESS – suppress specific metrics from an alert; OFFICE_HOURS – pause an alert for the specified period. SUPPRESS and OFFICE_HOURS events can also be used for display and event correlation. This field is required for SUPPRESS and OFFICE_HOURS events. |
| Action | (Optional) Indicates whether the event marks the beginning or end of the specified period. Possible values: START, END. This field is required for SUPPRESS and OFFICE_HOURS events. |