---
title: "Edit an Auto Response Rule"
method: PATCH
path: "/auto-response/rules/{id}"
tags: ["Auto Response"]
---

# Edit an Auto Response Rule

`PATCH /auto-response/rules/{id}`

Edit an Auto Response Rule. The current user can edit this rule when they have access to all businesses and locations that identify this rule.

## Path parameters

- `id` string, required

## Response `200`

Auto Response Rule updated.

- object
  - `status` 'SUCCESS' | 'PENDING' | 'QUOTA_LIMIT_EXCEED' | 'NOT_AUTHORIZED' | 'FORBIDDEN' | 'BAD_ACCESS_TOKEN' | 'BAD_PRIVATE_KEY' | 'BAD_PUBLIC_KEY' | 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'WRONG_PARAMETER_TYPE' | 'CONFLICT' | 'RESOURCE_LOCKED' | 'SERVER_ERROR' | 'ERROR' | 'NOT_FOUND' | 'BAD_REQUEST' | 'USER_ERROR' | 'PARTIAL_ERROR' | 'SERVICE_TEMPORARILY_UNAVAILABLE', required
  - `message` string — (optional) Holds further information about the response
  - `warnings` string[] — (optional) Holds further warnings
  - `response` object, required — Rule Response
    - `id` string — Uniquely identifies this Auto Response Rule
    - `businesses` object[] — List of business ids that identify this Auto Response Rule
      - `id` integer — Business id
      - `name` string — Business name
    - `locations` object[] — List of location ids that identify this Auto Response Rule
      - `id` integer — Location id
      - `name` string — Location name
      - `business` object — Which Business this Location belongs to
        - `id` integer — Business id
        - `name` string — Business name
    - `excludedLocations` object[] — List of location ids that do not identify this Auto Response Rule, even when they might belong to a business that does identify this rule
      - `id` integer — Location id
      - `name` string — Location name
      - `business` object — Which Business this Location belongs to
        - `id` integer — Business id
        - `name` string — Business name
    - `name` string — Name for this Auto Response Rule
    - `status` 'ACTIVE' | 'INACTIVE' | 'DELETED' — Status of this Auto Response Rule, either ACTIVE or INACTIVE
    - `triggers` string[] — Triggers that apply to this Auto Response Rule, can be ONE_STAR, TWO_STAR, THREE_STAR, FOUR_STAR and/or FIVE_STAR
    - `responses` object[] — Possible responses for this Auto Response Rule
      - `response` string — The review response text
      - `isOpenAI` boolean — Whether or not the review response was generated with AI
    - `dateCreated` string, date-time — Date and time of creation
    - `dateUpdated` string, date-time — Date and time of last update
    - `canEdit` boolean — The current user can edit this rule when they have access to all businesses and locations that identify this rule
    - `locationCount` integer — Count of locations to which this rule applies

## Other responses

- `400` — Bad Request - The request was invalid or cannot be otherwise served
- `401` — Unauthorized - Authentication credentials are missing or invalid
- `403` — Forbidden - The request is understood, but has been refused or access is not allowed
- `404` — Not Found - The requested resource could not be found
- `409` — Conflict - The request conflicts with current state of the server

---

[API](https://skmtc.net/uberall/apis/uberall-api.md) · [All operations](https://skmtc.net/uberall/apis/uberall-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uberall/uberall-api/versions/ddc577c548ee/schema)