PATCH
/
v1
/
alerts
/
{id}
Update alert
curl --request PATCH \
  --url https://api.rootly.com/v1/alerts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "alerts",
    "attributes": {
      "noise": "noise",
      "source": "rootly",
      "summary": "<string>",
      "description": "<string>",
      "service_ids": [
        "<string>"
      ],
      "group_ids": [
        "<string>"
      ],
      "environment_ids": [
        "<string>"
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "external_url": "<string>",
      "alert_urgency_id": "<string>",
      "labels": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "data": {},
      "deduplication_key": "<string>",
      "alert_field_values_attributes": [
        {
          "alert_field_id": "<string>",
          "value": "<string>"
        }
      ]
    }
  }
}'
{
  "data": {
    "id": "d55f96af-4f5e-4eb3-a2e5-acde60cacd68",
    "type": "alerts",
    "attributes": {
      "short_id": "b7dn8g",
      "source": "pagerduty",
      "status": "open",
      "summary": "test update",
      "description": "test update",
      "labels": [
        {
          "key": "foo",
          "value": "bar"
        },
        {
          "key": "bar",
          "value": "baz"
        }
      ],
      "services": [
        {
          "id": "f4e2b4c2-32f5-4f67-9d20-785712d4c517",
          "alert_broadcast_channel": {},
          "alert_broadcast_enabled": false,
          "alert_urgency_id": null,
          "alerts_email_address": "service-8847a48a7be5fa04eeea04bbcca8317f@email.rootly.com",
          "alerts_email_enabled": false,
          "backstage_id": null,
          "color": "#F4CFD1",
          "cortex_id": null,
          "created_at": "2025-09-05T08:40:45.827-07:00",
          "datadog_id": null,
          "deleted_at": null,
          "description": "Iusto quia et vel.",
          "external_id": null,
          "github_repository_branch": "master",
          "github_repository_name": null,
          "gitlab_repository_branch": "master",
          "gitlab_repository_name": null,
          "heroku_app_name": null,
          "incident_broadcast_channel": {},
          "incident_broadcast_enabled": false,
          "incidents_count": 0,
          "kubernetes_deployment_name": null,
          "name": "Molestias impedit delectus in.",
          "notify_emails": [],
          "opsgenie_id": null,
          "opsgenie_team_id": null,
          "opslevel_id": null,
          "pagerduty_id": null,
          "position": 1,
          "public_description": null,
          "service_now_ci_sys_id": null,
          "show_uptime": true,
          "show_uptime_last_days": 60,
          "slack_aliases": [],
          "slack_channels": [],
          "slug": "molestias-impedit-delectus-in",
          "status": "operational",
          "team_id": 19,
          "updated_at": "2025-09-05T08:40:45.827-07:00"
        }
      ],
      "service_ids": [
        "f4e2b4c2-32f5-4f67-9d20-785712d4c517"
      ],
      "groups": [
        {
          "id": "25fa1a4b-b910-438a-9a34-9c17da4a8088",
          "admins_count": 0,
          "alert_broadcast_channel": {},
          "alert_broadcast_enabled": false,
          "alert_urgency_id": null,
          "alerts_email_address": "group-1d6d1f2e348c068bb7c4010a71540794@email.rootly.com",
          "alerts_email_enabled": false,
          "auto_add_members_when_attached": false,
          "backstage_id": null,
          "color": "#F4CFD1",
          "cortex_id": null,
          "created_at": "2025-09-05T08:40:45.838-07:00",
          "deleted_at": null,
          "description": null,
          "external_id": null,
          "incident_broadcast_channel": {},
          "incident_broadcast_enabled": false,
          "incidents_count": 0,
          "name": "Asperiores et at ut.",
          "notify_emails": [],
          "opsgenie_id": null,
          "opslevel_id": null,
          "pagerduty_id": null,
          "pagerduty_service_id": null,
          "pagertree_id": null,
          "position": 1,
          "service_now_ci_sys_id": null,
          "slack_aliases": [],
          "slack_channels": [],
          "slug": "asperiores-et-at-ut",
          "team_id": 19,
          "updated_at": "2025-09-05T08:40:45.838-07:00",
          "users_count": 0,
          "victor_ops_id": null
        }
      ],
      "group_ids": [
        "25fa1a4b-b910-438a-9a34-9c17da4a8088"
      ],
      "environments": [
        {
          "id": "acad7319-e4dd-4df4-86d2-8adf86af55eb",
          "color": "#000000",
          "created_at": "2025-09-05T08:40:45.850-07:00",
          "deleted_at": null,
          "description": "Ea ab aut explicabo.",
          "external_id": null,
          "incidents_count": 0,
          "name": "Officia qui laboriosam velit.",
          "notify_emails": [],
          "position": 1,
          "slack_aliases": [],
          "slack_channels": [],
          "slug": "officia-qui-laboriosam-velit",
          "team_id": 19,
          "updated_at": "2025-09-05T08:40:45.850-07:00"
        }
      ],
      "environment_ids": [
        "acad7319-e4dd-4df4-86d2-8adf86af55eb"
      ],
      "responders": [],
      "incidents": [
        {
          "id": "d18b1cd8-7720-4c98-b0a8-9e6bed3c2b10",
          "ability_cache": null,
          "acknowledged_at": null,
          "airtable_base_key": null,
          "airtable_record_id": null,
          "airtable_record_url": null,
          "airtable_table_name": null,
          "asana_task_id": null,
          "asana_task_url": null,
          "cancellation_message": null,
          "cancelled_at": null,
          "cancelled_by_user_id": null,
          "clickup_task_id": null,
          "clickup_task_url": null,
          "closed_at": null,
          "closed_by_user_id": null,
          "coda_doc_id": null,
          "coda_doc_url": null,
          "coda_page_id": null,
          "confluence_page_id": null,
          "confluence_page_url": null,
          "created_at": "2025-09-05T08:40:40.621-07:00",
          "created_from_slack_identifier": null,
          "current_tutorial_step": "not_started",
          "datadog_notebook_id": null,
          "datadog_notebook_url": null,
          "deleted_at": null,
          "detected_at": null,
          "dropbox_paper_id": null,
          "dropbox_paper_url": null,
          "duplicate_incident_id": null,
          "email_message_id": null,
          "embedding": null,
          "external_id": null,
          "freshservice_task_id": null,
          "freshservice_task_url": null,
          "freshservice_ticket_id": null,
          "freshservice_ticket_url": null,
          "genius_workflow_runs_count": 0,
          "github_issue_id": null,
          "github_issue_url": null,
          "gitlab_issue_id": null,
          "gitlab_issue_url": null,
          "go_to_meeting_id": null,
          "go_to_meeting_url": null,
          "google_calendar_event_id": null,
          "google_calendar_event_url": null,
          "google_drive_id": null,
          "google_drive_parent_id": null,
          "google_drive_url": null,
          "google_meeting_bot_id": null,
          "google_meeting_id": null,
          "google_meeting_transcript": {},
          "google_meeting_transcript_summary": null,
          "google_meeting_url": null,
          "in_triage_at": null,
          "in_triage_by_user_id": null,
          "incidents_action_items_count": 0,
          "incidents_tasks_count": 0,
          "jira_issue_id": null,
          "jira_issue_key": null,
          "jira_issue_url": null,
          "kind": "normal",
          "labels": {},
          "left_slack_channel_slack_user_ids": [],
          "linear_issue_id": null,
          "linear_issue_key": null,
          "linear_issue_url": null,
          "mattermost_channel_id": null,
          "mattermost_channel_name": null,
          "mattermost_channel_url": null,
          "mattermost_summary_timestamp": null,
          "microsoft_teams_channel_id": null,
          "microsoft_teams_channel_name": null,
          "microsoft_teams_channel_service_url": null,
          "microsoft_teams_channel_short_url": null,
          "microsoft_teams_channel_url": null,
          "microsoft_teams_meeting_bot_id": null,
          "microsoft_teams_meeting_id": null,
          "microsoft_teams_meeting_transcript": {},
          "microsoft_teams_meeting_transcript_summary": null,
          "microsoft_teams_meeting_url": null,
          "microsoft_teams_summary_message_id": null,
          "microsoft_teams_team_id": null,
          "microsoft_teams_team_internal_id": null,
          "mitigated_at": null,
          "mitigated_by_user_id": null,
          "mitigation_message": null,
          "motion_task_id": null,
          "motion_task_url": null,
          "notify_channels": {},
          "notify_emails": [],
          "notion_page_id": null,
          "notion_page_url": null,
          "opsgenie_alert_id": null,
          "opsgenie_alert_url": null,
          "opsgenie_incident_id": null,
          "opsgenie_incident_responder_ids": [],
          "opsgenie_incident_url": null,
          "outlook_event_id": null,
          "outlook_event_url": null,
          "pagerduty_incident_id": null,
          "pagerduty_incident_number": null,
          "pagerduty_incident_responder_ids": {},
          "pagerduty_incident_url": null,
          "pagertree_alert_id": null,
          "pagertree_alert_url": null,
          "parent_incident_id": null,
          "previous_attributes": {
            "updated_at": "2025-09-05T08:40:40.788-07:00",
            "incident_events": [
              "Started date has been set to <span class=\"badge badge-info-inverted\">September 5  8:40 AM PDT</span>",
              "Buster McCullough created this incident"
            ],
            "user_avatar_url": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KICAgICAg\nPHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8y\nMDAwL3N2ZyIgd2lkdGg9IjIwMCIgaGVpZ2h0PSIyMDAiIHZpZXdCb3g9IjAg\nMCAyMDAgMjAwIj4KICAgICAgICA8bGluZWFyR3JhZGllbnQgaWQ9ImdyYWRp\nZW50XzE3NTcwODY4NDRfODc3MTgiIGdyYWRpZW50VHJhbnNmb3JtPSJyb3Rh\ndGUoNDUpIj4KICAgICAgICAgIDxzdG9wIHN0b3AtY29sb3I9IiNmZmFmYmQi\nIG9mZnNldD0iMCUiIC8+CiAgICAgICAgICA8c3RvcCBzdG9wLWNvbG9yPSIj\nZmZhZmJkIiBvZmZzZXQ9IjEwMCUiIC8+CiAgICAgICAgPC9saW5lYXJHcmFk\naWVudD4KICAgICAgICA8cmVjdCB3aWR0aD0iMTAwJSIgaGVpZ2h0PSIxMDAl\nIiBmaWxsPSJ1cmwoI2dyYWRpZW50XzE3NTcwODY4NDRfODc3MTgpIiAvPgog\nICAgICAgIDx0ZXh0IGZpbGw9IiNGRkYiIGZvbnQtZmFtaWx5PSJPcGVuIFNh\nbnMsSGVsdmV0aWNhLEFyaWFsLHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iMTAx\nIiBmb250LXdlaWdodD0iNTAwIiB4PSI1MCUiIHk9IjU1JSIgZG9taW5hbnQt\nYmFzZWxpbmU9Im1pZGRsZSIgdGV4dC1hbmNob3I9Im1pZGRsZSI+CiAgICAg\nICAgICBCTQogICAgICAgIDwvdGV4dD4KICAgICAgPC9zdmc+CiAgICA=\n"
          },
          "private": false,
          "public_title": null,
          "quip_page_id": null,
          "quip_page_url": null,
          "resolution_message": null,
          "resolved_at": null,
          "resolved_by_user_id": null,
          "retrospective_auto_skipped": false,
          "retrospective_completed_at": null,
          "retrospective_mandatory": false,
          "retrospective_progress_status": "not_started",
          "retrospective_started_at": null,
          "scheduled_auto_completed": true,
          "scheduled_auto_in_progress": true,
          "scheduled_for": null,
          "scheduled_remind_prior": false,
          "scheduled_until": null,
          "sequential_id": 1,
          "service_now_incident_id": null,
          "service_now_incident_key": null,
          "service_now_incident_url": null,
          "severity_id": "dc6345dc-aa5f-4962-bddf-9202fad918f5",
          "sharepoint_page_id": null,
          "sharepoint_page_url": null,
          "short_url": null,
          "shortcut_story_id": null,
          "shortcut_story_url": null,
          "shortcut_task_id": null,
          "shortcut_task_url": null,
          "slack_aliases": [],
          "slack_channel_archived": false,
          "slack_channel_deep_link": null,
          "slack_channel_id": null,
          "slack_channel_name": null,
          "slack_channel_short_url": null,
          "slack_channel_url": null,
          "slack_channel_workspace_id": null,
          "slack_channels": [],
          "slack_last_message_ts": null,
          "slack_notify_ready_for_retrospective_timestamp": null,
          "slack_summary_timestamp": null,
          "slug": "nostrum-et-dolores-vero",
          "source": "web",
          "started_at": "2025-09-05T08:40:40.621-07:00",
          "started_by_user_id": 46,
          "status": "started",
          "status_page_io": {},
          "status_page_io_components": [],
          "status_pages_count": 0,
          "sub_incidents_count": 0,
          "sub_status_id": "27859e69-94a0-432a-a9ce-2ebce69763c8",
          "subscribers_count": 0,
          "summary": "Quo id nihil. Sint quis molestiae. Quia ipsa fugiat.",
          "summary_updated_at": null,
          "team_id": 19,
          "title": "Nostrum et dolores vero.",
          "title_autogenerated": false,
          "trello_card_id": null,
          "trello_card_url": null,
          "triggered_from_microsoft_teams_channel_id": null,
          "triggered_from_slack_channel_id": null,
          "triggered_from_slack_message_ts": null,
          "triggered_from_slack_thread_ts": null,
          "updated_at": "2025-09-05T08:40:44.730-07:00",
          "user_id": 46,
          "users_assigned_count": 0,
          "using_redesigned_slack_announcement": true,
          "using_redesigned_slack_updates": true,
          "victor_ops_incident_id": null,
          "victor_ops_incident_responder_ids": {},
          "victor_ops_incident_url": null,
          "view_source": null,
          "webex_meeting_bot_id": null,
          "webex_meeting_id": null,
          "webex_meeting_transcript": {},
          "webex_meeting_transcript_summary": null,
          "webex_meeting_url": null,
          "zendesk_ticket_id": null,
          "zendesk_ticket_url": null,
          "zoom_meeting_bot_id": null,
          "zoom_meeting_global_dial_in_numbers": [],
          "zoom_meeting_h323_password": null,
          "zoom_meeting_id": null,
          "zoom_meeting_join_url": null,
          "zoom_meeting_password": null,
          "zoom_meeting_pstn_password": null,
          "zoom_meeting_start_url": null,
          "zoom_meeting_transcript": {},
          "zoom_meeting_transcript_summary": null,
          "raw_labels": null,
          "tutorial_steps": null
        }
      ],
      "data": {},
      "deduplication_key": null,
      "started_at": "2025-09-05T08:40:43.654-07:00",
      "ended_at": null,
      "external_id": null,
      "external_url": "http://schinner.example/rhea",
      "url": "https://test.rootly.com/account/alerts/d55f96af-4f5e-4eb3-a2e5-acde60cacd68",
      "noise": "not_noise",
      "notification_target_type": null,
      "notification_target_id": null,
      "alert_urgency": {
        "id": "fc56899f-2c35-4110-a315-c0d99e8b55dd",
        "color": "#C73C40",
        "created_at": "2025-09-05T08:40:44.000-07:00",
        "deleted_at": null,
        "description": "Corporis perferendis voluptatem labore.",
        "name": "yoxpo",
        "position": 1,
        "team_id": 27,
        "updated_at": "2025-09-05T08:40:44.005-07:00",
        "urgency": "high"
      },
      "alert_urgency_id": "fc56899f-2c35-4110-a315-c0d99e8b55dd",
      "notified_users": [],
      "created_at": "2025-09-05T08:40:43.654-07:00",
      "updated_at": "2025-09-05T08:40:51.258-07:00"
    },
    "relationships": {
      "events": {
        "data": [
          {
            "id": "5e2632b3-dbc6-405a-91f6-9e48d841ad27",
            "type": "alert_events"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/vnd.api+json

Response

200
application/vnd.api+json

removes existing alert field values and adds new ones

The response is of type object.