---
title: "Update Service"
method: PATCH
path: "/v1/services/{serviceId}"
tags: ["Services"]
---

# Update Service

`PATCH /v1/services/{serviceId}`

## Request

- Base URL: `https://api.bluehive.com`
- URL: `https://api.bluehive.com/v1/services/{serviceId}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bluehive-health/apis/bluehive-api/docs/v1/services/:serviceId/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `serviceId` string, required

## Request body

- object
  - `name` string
  - `brandId` string
  - `providerId` string
  - `description` string
  - `slug` string
  - `family` string
  - `subFamily` string
  - `groupName` string
  - `aliases` object[]
    - `name` string, required
  - `codes` object[]
    - `type` string, required
    - `code` string, required
  - `visibility` 'active' | 'deleted'

## Response `200`

Default Response

- object
  - `_id` string, required
  - `name` string, required
  - `brandId` string
  - `providerId` string
  - `description` string
  - `slug` string
  - `family` string
  - `subFamily` string
  - `groupName` string
  - `aliases` object[]
    - `name` string, required
  - `codes` object[]
    - `type` string, required
    - `code` string, required
  - `visibility` string
  - `createdAt` string, date-time, required
  - `createdBy` unknown
  - `updatedAt` string, date-time
  - `updatedBy` unknown

## Other responses

- `400`: Default Response
- `403`: Default Response
- `404`: Default Response
- `500`: Default Response

## Changes

- **2026-10-16** `a8bcbdf02e33`: 2 warning, 4 info
  - removed the request property `alwaysAvailable`
  - removed the optional property `alwaysAvailable` from the response with the `200` status
  - the response property `aliases/items/name` became required for the status `200`
  - the response property `codes/items/code` became required for the status `200`
  - …2 more
- **2026-08-21** `ae97a9add0ba`: 2 info
  - added the new optional request property `alwaysAvailable`
  - added the optional property `alwaysAvailable` to the response with the `200` status
- **2026-08-15** `d753865b0837`: 4 breaking
  - the response property `aliases/items/name` became optional for the status `200`
  - the response property `codes/items/code` became optional for the status `200`
  - the response property `codes/items/type` became optional for the status `200`
  - the response property `createdAt` became optional for the status `200`
- **2026-08-13** `e6e553c2594a`: 4 info
  - the response property `aliases/items/name` became required for the status `200`
  - the response property `codes/items/code` became required for the status `200`
  - the response property `codes/items/type` became required for the status `200`
  - the response property `createdAt` became required for the status `200`
- …earlier changes not shown

[Operation history](https://skmtc.dev/bluehive-health/apis/bluehive-api/changes/v1/services/:serviceId/patch.md)

---

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