POST /hr_api/v1/worksites

Creates a new Worksite

Params

Property Required Details Location

name

Must be a String

JSON

category_status

Must be one of: active, inactive.

JSON

worksite_id_string

Must be a String

JSON

business_unit_ids

Must be an array of any type

JSON

Examples

POST /hr_api/v1/worksites
{
  "name": "Worksite name",
  "category_status": "active",
  "worksite_id_string": "worksite_id_string",
  "business_unit_ids": [
    1
  ]
}
201
{
  "message": "Worksite successfully created",
  "worksite": {
    "name": "example_name",
    "uuid": "d5fdf46b-f0bb-4a1c-bfae-97811b1745a2",
    "details": null,
    "travel_directions": null,
    "parking_instructions": null,
    "environment_name": null,
    "web_url": null,
    "worksite_id_string": "example_worksite_id_string",
    "category_status": "Active",
    "flagship": null,
    "sort": null,
    "title": null
  }
}