---
title: "Close a help request (the asker)"
method: PATCH
path: "/api/v1/help_requests/{id}"
tags: ["Devices"]
---

# Close a help request (the asker)

`PATCH /api/v1/help_requests/{id}`

## Request

- Base URL: `https://saltapp.ai`
- URL: `https://saltapp.ai/api/v1/help_requests/{id}`
- Auth: one of:
  - API key in header `api-key`
  - OAuth 2 (authorization code, authorization URL `https://saltapp.ai/oauth2/authorize`, token URL `https://saltapp.ai/api/oauth2/token`, scopes: `chat`)

`answered` (it worked) or `withdrawn`. Stops the stills, clears the person's notification and tells their open screens. Closing a closed request reads it back as it is.

## Path parameters

- `id` string, required

## Request body

- object
  - `status` 'answered' | 'withdrawn', required

## Response `200`

OK.

- object
  - `help_request` object: A ring: ids, the reason and the status. Never the question or a picture.
    - `id` string
    - `agent` object: The asker (any account).
      - `id` string
      - `username` string
      - `display_name` string
    - `person_id` string: The recipient.
    - `chat_id` string
    - `message_id` string: The help question, an encrypted message the asker sent.
    - `reason` 'stuck' | 'which' | 'unclear' | 'look'
    - `status` 'open' | 'answered' | 'withdrawn' | 'ended'
    - `device_session_id` string, nullable
    - `device` object, nullable: The computer the request rides on; null without a session.
      - `id` string
      - `name` string
      - `lane_chat_id` string: The device lane the stills and points travel in.
    - `created_at` string, date-time
    - `closed_at` string, date-time, nullable
    - `last_viewed_at` string, date-time, nullable

## Other responses

- `401`: Missing or invalid credentials.
- `404`: Unknown or not yours to close.
- `422`: status must be answered or withdrawn.

---

[API](https://skmtc.dev/saltapp/apis/salt-agent-api.md) · [All operations](https://skmtc.dev/saltapp/apis/salt-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/saltapp/apis/salt-agent-api/revisions/a8b8642ab7f8?raw)