---
title: "Update a workplace"
method: PATCH
path: "/workplaces/{workplace}"
---

# Update a workplace

`PATCH /workplaces/{workplace}`

Updates the specified workplace.

## Path parameters

- `workplace` string, required

## Request body

- object
  - `company` string — Company ID to associate with the workplace.
  - `name` string — Name for the workplace.
  - `address` object
    - `line1` string, required — Street address or PO Box
    - `line2` string — Apartment, suite, unit, or building
    - `city` string, required — City, district, suburb, town, or village
    - `state` string, required — 2-digit state code
    - `postal_code` string, required — 5-digit postal code or zip code
    - `country` string — Read only.
  - `active` boolean — Indicates whether the workplace can be associated with an employee for payroll
  - `metadata` string, json — Additional loosely structured information to associate with the workplace

## Response `200`

200

- object
  - `id` string
  - `name` string
  - `address` object
    - `line1` string
    - `line2` unknown
    - `city` string
    - `state` string
    - `postal_code` string
    - `country` string
  - `company` string
  - `active` boolean
  - `metadata` object

---

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