Account1

Authentication2

Availability10

Companies5

Day Part1

Departments5

Employment Record5

Engage2

External User Mappings12

Forecast Overrides4

Locations5

Log Book12

Orders13

Receipts5

Reports6

Roles5

Schedule Enforcement1

Schedule Events5

Shifts5

Task Management13

Time Clocking2

Time Off10

Time Punches5

Tip Pool5

User Assignments12

User Wages2

Users9

Webhooks5

Schedule Events

Create Event

post/v2/company/{company_id}/events

Request

Base URL
https://api.7shifts.com
Auth
- OAuth 2
  Authorization codehttps://app.7shifts.com/oauth2/authorize
  Client credentials
  Password
  Token URLhttps://app.7shifts.com/oauth2/token
- or API key in cookie 7session
TypeScript
https://skmtc.dev/7shifts/apis/7shifts-api/docs/v2/company/:company_id/events/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

company_idinteger required

Company ID

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Request body

location_idsinteger[] required

The list of locations where this event occurs

start_datestring required

Start date

start_timestring required

Start time

end_datestring required

End date for multi-day events

end_timestring required

End time

titlestring required

The name of the event

descriptionstring nullable

Description for event

colorstring nullable

A hex number representing the color

is_multi_dayboolean required

If true, the event is a multi-day event

recurrencestring nullable

Recurrence rules as defined by the RFC 5545 spec

Example request

{
  "start_date": "2019-01-01",
  "start_time": "09:00:00",
  "end_date": "2019-01-02",
  "end_time": "17:00:00",
  "color": "5ea17c",
  "recurrence": "Daily for 10 occurrences ==> (1997 9:00 AM EDT) September 2-11 DTSTART;TZID=America/New_York:19970902T090000 RRULE:FREQ=DAILY;COUNT=10"
}

Response

idinteger required

event_type'general' | 'birthday' | 'work_anniversary' required