v1

latestOpenAPI 3.0.22026-07-24154101.1 MB

Locations

Update Location

put/v2/company/{company_id}/locations/{location_id}

Path parameters

company_idinteger required

Company ID

location_idinteger required

Location ID

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Request body

namestring

Location name

citystring nullable

City

countrystring

Country

statestring nullable

State or province

shift_feedbackboolean

If true end of shift feedback requests are enabled

formatted_addressstring

latnumber

lngnumber

place_idstring nullable

timezonestring

Timezone. Valid zone info name

hashstring

department_based_budgetboolean

holiday_payboolean nullable

When true, holiday pay is enabled

auto_send_log_book_timestring

A timestamp with hh:mm:ss format

sun_hours_closestring nullable

Sunday closing time

mon_hours_closestring nullable

Monday closing time

tue_hours_closestring nullable

Tuesday closing time

wed_hours_closestring nullable

Wednesday closing time

thu_hours_closestring nullable

Thursday closing time

fri_hours_closestring nullable

Friday closing time

sat_hours_closestring nullable

Saturday closing time

sun_hours_openstring nullable

Sunday opening time

mon_hours_openstring nullable

Monday opening time

tue_hours_openstring nullable

Tuesday opening time

wed_hours_openstring nullable

Wednesday opening time

thu_hours_openstring nullable

Thursday opening time

fri_hours_openstring nullable

Friday opening time

sat_hours_openstring nullable

Saturday opening time

sun_is_closedboolean nullable

If true, location is closed on Sunday

mon_is_closedboolean nullable

If true, location is closed on Monday

tue_is_closedboolean nullable

If true, location is closed on Tuesday

wed_is_closedboolean nullable

If true, location is closed on Wednesday

thu_is_closedboolean nullable

If true, location is closed on Thursday

fri_is_closedboolean nullable

If true, location is closed on Friday

sat_is_closedboolean nullable

If true, location is closed on Saturday

messagestring

Message visible to all employees

Example request

{
  "name": "Quackers",
  "city": "Toronto",
  "country": "CA",
  "state": "ON",
  "shift_feedback": true,
  "formatted_address": "200 Bathurst Street, Toronto, ON, Canada",
  "lat": 43.6478436,
  "lng": -79.4043708,
  "place_id": "ChIJUyrhFOc0K4gRyuFq6AUlfmE",
  "timezone": "America/Chicago",
  "sun_is_closed": true,
  "mon_is_closed": true,
  "tue_is_closed": true,
  "wed_is_closed": true,
  "thu_is_closed": true,
  "fri_is_closed": true,
  "sat_is_closed": true,
  "message": "msg"
}

Response

object'location' required

Example response

{
  "data": {
    "id": 1234,
    "company_id": 1234,
    "name": "Quackers",
    "country": "CA",
    "state": "ON",
    "city": "Toronto",
    "formatted_address": "200 Bathurst Street, Toronto, ON, Canada",
    "lat": 43.6478436,
    "lng": -79.4043708,
    "place_id": "ChIJUyrhFOc0K4gRyuFq6AUlfmE",
    "timezone": "America/Chicago",
    "timezone_updated": true,
    "auto_send_log_book_time": "03:00",
    "sun_is_closed": true,
    "mon_is_closed": true,
    "tue_is_closed": true,
    "wed_is_closed": true,
    "thu_is_closed": true,
    "fri_is_closed": true,
    "sat_is_closed": true,
    "shift_feedback": true,
    "message": "msg",
    "created": "2020-01-01T12:00:00+00:00",
    "modified": "2020-01-02T12:00:00+00:00"
  }
}