---
title: "Update Escalation Group"
method: PATCH
path: "/escalation-groups/{escalation_group_id}"
tags: ["authenticated", "escalation-groups"]
---

# Update Escalation Group

`PATCH /escalation-groups/{escalation_group_id}`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/escalation-groups/{escalation_group_id}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Path parameters

- `escalation_group_id` string, required

## Headers

- `organization-id` string, nullable
- `x-user-id` string, nullable
- `timezone` string
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Request body

- UpdateEscalationGroupBody
  - `name` string, nullable
  - `target_index` integer, nullable

## Response `200`

Successful Response

- EscalationGroupViewPublic
  - `escalation_group_id` string, required
  - `name` string, required
  - `position` number, required
  - `is_default` boolean, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `escalations` EscalationBasicPublic[]
    - `escalation_id` string, required
    - `escalation_group_id` string, required
    - `engagement_id` string, required
    - `customer` EscalationCustomerPublic: Who an escalation is about. ``service_address`` is carried alongside ``name`` rather than as a fallback: ServiceTitan names are frequently placeholders ("current resident"), so the address is often the only field that identifies the record. ``phone`` is the number the escalation can be followed up on. A lead that never gave a name and was never matched to a ServiceTitan customer has neither ``name`` nor ``service_address``, so it is often the only thing on the card that makes the customer reachable.
      - `contact_id` string, required
      - `name` string, nullable
      - `st_customer_id` integer, nullable
      - `service_address` string, nullable
      - `phone` string, nullable
      - `href` string, nullable
    - `position` number, required
    - `reason` 'emergency_request' | 'urgent_request' | 'contact_is_angry_or_hostile' | 'contact_other_person_request' | 'technical_issue' | 'contact_is_deceased' | 'wrong_number' | 'appointment_not_booked' | 'contact_no_response' | 'sales_or_billing_follow_up' | 'membership_cancellation' | 'estimate_acceptance' | 'no_availability' | 'cannot_serve_needs_review' | 'scheduling_assistance_needed' | 'other' | 'lead_no_response' | 'do_not_contact_inbound' | 'ambiguous_st_customer_match', required
    - `summary` string, required
    - `note` string, nullable
    - `status` 'open' | 'claimed' | 'resolved', required
    - `assigned_to` UserBasicPublic
      - `user_id` string, required
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `email` string, required
      - `image` string, nullable
    - `resolved_at` string, date-time, nullable
    - `archived_at` string, date-time, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `note_events` EscalationNoteEventPublic[]
      - `id` string, required
      - `event_type` string, required
      - `note_text` string, nullable
      - `created_at` string, date-time, required
      - `saved_by` UserBasicPublic
        - `user_id` string, required
        - `first_name` string, nullable
        - `last_name` string, nullable
        - `email` string, required
        - `image` string, nullable
    - `resolution` EscalationResolutionPublic: The transition that put the escalation in its current resolved state. ``saved_by`` is null whenever ``source`` is not ``user`` — an automatic resolve has no person behind it — so clients must branch on ``source`` rather than treating a missing user as unknown attribution.
      - `id` string, required
      - `event_type` string, required
      - `source` string, required
      - `created_at` string, date-time, required
      - `saved_by` UserBasicPublic
        - `user_id` string, required
        - `first_name` string, nullable
        - `last_name` string, nullable
        - `email` string, required
        - `image` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/86e2c2bd93af?raw)