Home B2Core API REST API The Back Office API Calendar events

Calendar events

Use these methods to manage the events scheduled for Back Office users.

GET[host]/api/v2/calendars/events	Get a list of calendar events
GET[host]/api/v2/calendars/events/{eventId}	Get calendar event details
POST[host]/api/v2/calendars/events	Add a calendar event
PUT[host]/api/v2/calendars/events/{eventId} PATCH[host]/api/v2/calendars/events/{eventId}	Update a calendar event
DELETE[host]/api/v2/calendars/events/{eventId}	Delete a calendar event

Get a list of calendar events

Use this method to obtain a list of the events scheduled for Back Office users.

To obtain detailed information about a specific event, use a separate method to get calendar event details.

Request

Header parameters:

• Authorization: Bearer <token>

Query parameters:

The following filter parameters are available for this method:

startDate

The start date and time of the event.

endDate

The end date and time of the event.

recipients

The email addresses of the Back Office users added to the event.

name

The event name.

description

The event description.

Refer to the Query parameters section of the Overview for details on applying filter and sorting parameters.

GET[host]/api/v2/calendars/events

curl --location -g 'https://host.name/api/v2/calendars/events?limit=10&offset=0&sort_order=desc&sort_by=startTime&filter[startDate]=2022-01-01T00%3A00%3A00%2B00%3A00&filter[endDate]=2022-01-01T00%3A00%3A00%2B00%3A00&filter[recipients]=user@example.com&filter[name]=Name&filter[description]=Description' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response includes an array of Calendar Event objects providing information about the calendar events matching the request parameters.

Get calendar event details

Use this method to obtain detailed information about a specified calendar event.

To obtain a list of scheduled events, use a separate method to get a list of calendar events.

Request

Header parameters:

• Authorization: Bearer <token>

Path parameters:

eventId required

The event identifier.

GET[host]/api/v2/calendars/events/{eventId}

curl --location -- request GET 'https://host.name/api/v2/calendars/events/1' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response includes a Calendar Event object providing information about the specified event.

Add a calendar event

Use this method to schedule a new event for Back Office users.

Request

Header parameters:

• Authorization: Bearer <token>

Body:

Specify the following parameters for an event:

caption string

The event name.

description string

The event description.

startDate string

The start date and time of the event.

endDate string

The end date and time of the event.

notifications array

An array of string values specifying the date and time of reminder notifications.

recipients array

An array of string values specifying the email addresses of the Back Office users that you want to add to an event.

POST[host]/api/v2/calendars/events

curl --location 'https://host.name/api/v2/calendars/events' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja' \
--data-raw '{
  "caption": "Name",
  "description": "Description",
  "startDate": "2022-01-01T00:00:00+00:00",
  "endDate": "2022-01-01T00:00:00+00:00",
  "notifications": [
    "PT2H"
  ],
  "recipients": [
    "user@example.com"
  ]
}'

Response

A response includes a Calendar Event object providing information about the added event.

Update a calendar event

Use this method to update a specified event scheduled for Back Office users.

Note

Instead of the method described below, you can use a similar method that uses the HTTP verb PATCH.

Request

Header parameters:

• Authorization: Bearer <token>

Path parameters:

eventId required

The event identifier.

Body:

The following field values can be updated for a specified event:

caption string

The event name.

description string

The event description.

startDate string

The start date and time of the event.

endDate string

The end date and time of the event.

notifications array

An array of string values specifying the date and time of reminder notifications.

recipients array

An array of string values specifying the email addresses of the Back Office users that you want to add to the event.

PUT[host]/api/v2/calendars/events/{eventId}

curl --location --request PUT 'https://host.name/api/v2/calendars/events/1' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja' \
--data-raw '{
  "caption": "Name",
  "description": "Description",
  "startDate": "2022-01-01T00:00:00+00:00",
  "endDate": "2022-01-01T00:00:00+00:00",
  "notifications": [
    "PT2H"
  ],
  "recipients": [
    "user@example.com"
  ]
}'

Response

A response includes a Calendar Event object providing information about the updated event.

Delete a calendar event

Use this method to remove an existing event.

Request

Header parameters:

• Authorization: Bearer <token>

Path parameters:

eventId required

The event identifier.

DELETE[host]/api/v2/calendars/events/{eventId}

curl --location --request DELETE 'https://host.name/api/v2/calendars/events/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.