API Reference

Create a new event

post
https://integrate.rooflink.com/roof_link_endpoints/api/light/events/

Creates a new event for the authenticated user's company.

Permission Requirements:

  • The authenticated user must be an employee (crew members cannot create events).
  • The created_by field is automatically set to the authenticated user.
  • The company field is automatically set from the user's company.

Auto-generated Fields:

  • User's timezone is automatically activated for the event.
  • Calendar associations are created if add_to_my_calendar is true.
  • Email and SMS notifications are sent to invitees automatically.
  • Calendar sync tasks are triggered for Google Calendar and Outlook integration.

Validation Rules:

  • The start time must be before the end time.
  • Event duration must be at least 15 minutes.
  • Start times before 7 AM are adjusted to 7 AM (unless all_day or any_time is true).
  • End times before 8 AM are adjusted to 8 AM (unless all_day or any_time is true).
  • Invitees must be valid user IDs within the company.

Field Restrictions:

  • The job field can only be set during creation and cannot be modified later.
  • Only non-recurring events can be created through this endpoint.
Body Params

Request body containing the event data to create.

string
required
length between 1 and 1000

The name or title of the event.

string | null

Detailed description of the event. HTML will be stripped in list views and truncated to 120 characters.

date-time
required

Event start date and time in ISO 8601 format. Must be before the end time.

date-time
required

Event end date and time in ISO 8601 format. Must be after start time. Minimum event duration is 15 minutes.

boolean
Defaults to false

Whether this is an all-day event. When true, specific times are ignored.

boolean
Defaults to false

Whether this event can occur at any time without a specific schedule.

invitees
array of integers | null

Array of user IDs to invite to the event. Must be valid users within the company.

invitees
tags
array of strings | null

Array of tag strings for categorizing the event. Valid tags are defined in company settings.

tags
boolean
Defaults to false

Whether to add this event to the creator's personal calendar. This triggers calendar association creation.

string | null
enum

When to send reminder notifications for this event. Notifications are sent via email and SMS to invitees.

integer | null

Job ID to associate with this event. This field can only be set during creation and cannot be updated later.

integer | null

Event template ID to use for pre-populating event fields. Template data is used to fill in name, description, invitees, tags, and timing.

Responses

Updated about 2 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago