v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Update a workplace

Updates the specified workplace.

patch/workplaces/{workplace}

Path parameters

workplacestring required

Request body

companystring

Company ID to associate with the workplace.

namestring

Name for the workplace.

activeboolean

Indicates whether the workplace can be associated with an employee for payroll

metadatastring json

Additional loosely structured information to associate with the workplace

Response

200

idstring

namestring

companystring

activeboolean

metadataobject

Example response

{
  "id": "wrk_oRgjEaRycoCPuS5TqVkm",
  "name": "New York Office",
  "address": {
    "line1": "200 Park Ave",
    "city": "New York",
    "state": "NY",
    "postal_code": "10166",
    "country": "US"
  },
  "company": "com_P7JPeBhb8hH23iiReDQ5",
  "active": true
}