Calendar Events
A Partner can create events in Jobylon involving users and applicants from any customer account they have access to. Jobylon, along with its integrations, will ensure the event is delivered to all participants.
The API also provides access to a user’s calendar availability.
Create
POST /events/
Query String Parameters
None
Request Payload
Name | Type | Mandatory? | Description |
|---|---|---|---|
description | string | yes | Description of the Event |
duration | integer | yes | Duration of the event in minutes. Maximum allowed is 480. |
location | string | no | Address of the Event (example: Sankt Eriksgatan 63B, 112 34 Stockholm, Sweden) |
organizer | string | yes | Email of the User who organizes the Event |
participants | list | yes | List of Application IDs invited for the Event |
attendees | list | no | List of emails of company Users who will attend the event |
start_time | datetime | yes | Datetime of the Event in the format %Y-%m-%dT%H:%M:%S |
timezone | string | yes | Timezone of the Event (example: Europe/Stockholm) |
title | string | yes | Title of the Event |
videoconferencing | boolean | no | Whether or not the event includes a video conference. Jobylon will create a video conference link if this option is set to True |
Response
Name | Type | Description |
|---|---|---|
id | integer | Event ID |
Exceptions
Status | Description |
|---|---|
400 | Bad request Invalid field format or data The organizer or a participant does not belong to a customer account accessible by the Partner |
403 | Permission denied |
405 | Method not supported |
Update
A PushAPI Partner can only update events that have been created by the Partner. Events created by another Partner or created in Jobylon using other means will not be available.
PUT /events/<event_id>/
Query String Parameters
None
Request Payload
Name | Type | Mandatory? | Description |
|---|---|---|---|
description | string | yes | Description of the Event |
duration | integer | yes | Duration of the event in minutes. Maximum allowed is 480 |
start_time | datetime | yes | Datetime of the Event in the format %Y-%m-%dT%H:%M:%S |
timezone | string | yes | Timezone of the Event (example: Europe/Stockholm) |
title | string | yes | Title of the Event |
Exceptions
Status | Description |
|---|---|
400 | Bad request Invalid field format or data |
403 | Permission denied |
404 | Method not supported |
Delete
A PushAPI Partner can only delete events that have been created by the Partner. Events created by another Partner or created in Jobylon using other means will not be available.
DEL /events/<event_id>/
Query String Parameters
None
Request Payload
None
Exceptions
Status | Description |
|---|---|
403 | Permission denied |
404 | Event not found |