Skip to main content
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": "268ba493-28c2-4282-82e4-b5181899025c",
    "type": "alerts",
    "attributes": {
      "short_id": "xz4i18",
      "source": "pagerduty",
      "status": "open",
      "summary": "test update",
      "description": "test update",
      "labels": [
        {
          "key": "foo",
          "value": "bar"
        },
        {
          "key": "bar",
          "value": "baz"
        }
      ],
      "services": [
        {
          "id": "1bd38002-634c-413c-9f25-805c700da407",
          "alert_broadcast_channel": {},
          "alert_broadcast_enabled": false,
          "alert_urgency_id": null,
          "alerts_email_address": "service-c4f5fe98abf561f40a35fda374459fa6@email.rootly.com",
          "alerts_email_enabled": false,
          "backstage_id": null,
          "color": "#F4CFD1",
          "cortex_id": null,
          "created_at": "2025-10-03T19:33:34.373-07:00",
          "datadog_id": null,
          "deleted_at": null,
          "description": "Dolore cupiditate error dolorum.",
          "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": "In inventore et autem.",
          "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": "in-inventore-et-autem",
          "status": "operational",
          "team_id": 19,
          "updated_at": "2025-10-03T19:33:34.373-07:00"
        }
      ],
      "service_ids": [
        "1bd38002-634c-413c-9f25-805c700da407"
      ],
      "groups": [
        {
          "id": "21947056-5f22-4f2d-8d6a-60eef801e50d",
          "admins_count": 0,
          "alert_broadcast_channel": {},
          "alert_broadcast_enabled": false,
          "alert_urgency_id": null,
          "alerts_email_address": "group-473a0edd9603e75a35d7f752cb5402de@email.rootly.com",
          "alerts_email_enabled": false,
          "auto_add_members_when_attached": false,
          "backstage_id": null,
          "color": "#F4CFD1",
          "cortex_id": null,
          "created_at": "2025-10-03T19:33:34.395-07:00",
          "deleted_at": null,
          "description": null,
          "external_id": null,
          "incident_broadcast_channel": {},
          "incident_broadcast_enabled": false,
          "incidents_count": 0,
          "name": "Enim minus quos inventore.",
          "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": "enim-minus-quos-inventore",
          "team_id": 19,
          "updated_at": "2025-10-03T19:33:34.395-07:00",
          "users_count": 0,
          "victor_ops_id": null
        }
      ],
      "group_ids": [
        "21947056-5f22-4f2d-8d6a-60eef801e50d"
      ],
      "environments": [
        {
          "id": "10f56dbf-756b-43dc-a8d7-d70457e95bd5",
          "color": "#54e854",
          "created_at": "2025-10-03T19:33:34.418-07:00",
          "deleted_at": null,
          "description": "Quis quo est aut.",
          "external_id": null,
          "incidents_count": 0,
          "name": "Ut eos numquam debitis.",
          "notify_emails": [],
          "position": 1,
          "slack_aliases": [],
          "slack_channels": [],
          "slug": "ut-eos-numquam-debitis",
          "team_id": 19,
          "updated_at": "2025-10-03T19:33:34.418-07:00"
        }
      ],
      "environment_ids": [
        "10f56dbf-756b-43dc-a8d7-d70457e95bd5"
      ],
      "responders": [],
      "incidents": [
        {
          "id": "66ab95d3-0144-4898-93a6-d5ac1cc3c0c5",
          "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-10-03T19:33:24.801-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-10-03T19:33:25.182-07:00",
            "incident_events": [
              "Started date has been set to <span class=\"badge badge-info-inverted\">October 3  7:33 PM PDT</span>",
              "Lenny Bauch created this incident"
            ],
            "user_avatar_url": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KICAgICAg\nPHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8y\nMDAwL3N2ZyIgd2lkdGg9IjIwMCIgaGVpZ2h0PSIyMDAiIHZpZXdCb3g9IjAg\nMCAyMDAgMjAwIj4KICAgICAgICA8bGluZWFyR3JhZGllbnQgaWQ9ImdyYWRp\nZW50XzE3NTk1NDUyMTJfNTg0MzQzIiBncmFkaWVudFRyYW5zZm9ybT0icm90\nYXRlKDkwKSI+CiAgICAgICAgICA8c3RvcCBzdG9wLWNvbG9yPSIjOTNhNWNm\nIiBvZmZzZXQ9IjAlIiAvPgogICAgICAgICAgPHN0b3Agc3RvcC1jb2xvcj0i\nIzkzYTVjZiIgb2Zmc2V0PSIxMDAlIiAvPgogICAgICAgIDwvbGluZWFyR3Jh\nZGllbnQ+CiAgICAgICAgPHJlY3Qgd2lkdGg9IjEwMCUiIGhlaWdodD0iMTAw\nJSIgZmlsbD0idXJsKCNncmFkaWVudF8xNzU5NTQ1MjEyXzU4NDM0MykiIC8+\nCiAgICAgICAgPHRleHQgZmlsbD0iI0ZGRiIgZm9udC1mYW1pbHk9Ik9wZW4g\nU2FucyxIZWx2ZXRpY2EsQXJpYWwsc2Fucy1zZXJpZiIgZm9udC1zaXplPSIx\nMDEiIGZvbnQtd2VpZ2h0PSI1MDAiIHg9IjUwJSIgeT0iNTUlIiBkb21pbmFu\ndC1iYXNlbGluZT0ibWlkZGxlIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIj4KICAg\nICAgICAgIExCCiAgICAgICAgPC90ZXh0PgogICAgICA8L3N2Zz4KICAgIA==\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": "485d0db5-e82b-4402-aaa6-215a9732630b",
          "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": "eius-rem-sunt-et",
          "source": "web",
          "started_at": "2025-10-03T19:33:24.801-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": "3be3127b-bdc9-437f-89de-0acf86ebcadc",
          "subscribers_count": 0,
          "summary": "Explicabo molestiae voluptatem. Vel similique cum. Fuga et labore.",
          "summary_updated_at": null,
          "team_id": 19,
          "title": "Eius rem sunt et.",
          "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-10-03T19:33:32.216-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-10-03T19:33:29.949-07:00",
      "ended_at": null,
      "external_id": null,
      "external_url": "http://mitchell-koch.test/demetrice_welch",
      "url": "https://test.rootly.com/account/alerts/268ba493-28c2-4282-82e4-b5181899025c",
      "noise": "not_noise",
      "notification_target_type": null,
      "notification_target_id": null,
      "alert_urgency": {
        "id": "f2eea0d3-30c3-4463-a5c5-cdaa3a4cea36",
        "color": "#C73C40",
        "created_at": "2025-10-03T19:33:30.532-07:00",
        "deleted_at": null,
        "description": "Sequi sunt deleniti eos.",
        "name": "0knae",
        "position": 1,
        "team_id": 27,
        "updated_at": "2025-10-03T19:33:30.543-07:00",
        "urgency": "high"
      },
      "alert_urgency_id": "f2eea0d3-30c3-4463-a5c5-cdaa3a4cea36",
      "notified_users": [],
      "created_at": "2025-10-03T19:33:29.949-07:00",
      "updated_at": "2025-10-03T19:33:41.816-07:00"
    },
    "relationships": {
      "events": {
        "data": [
          {
            "id": "7b1d4436-fb48-485f-8901-c59428797e1c",
            "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
data
object
required

Response

removes existing alert field values and adds new ones

data
object
required
I