Parameters

Parameter

Type

Required

Description

title

String

Yes

The title of the event.

description

String

No

The description of the event.

date

String

Yes

The date of the event (YYYY-mm-dd).

start

String

No

The time that the event starts at (HH:ii:ss).

end_date

String

No

The date that this event ends on (YYYY-mm-dd).

all_day

Boolean

No

Specifies whether the event is an all day event or not.

location_id

Array

Yes

An array of IDs that this event is tied to. Example [123,556]

color

String

No

The 6 letter hex code for the color of this event.

Example response

{
  "status": "success",
  "data": {
    "event": {
      "id": 123,
      "title": "Some title",
      "description": "The event description",
      "date": "2015-12-30",
      "start": "16:00:00",
      "all_day": false,
      "color": "00ff00",
      "created": "2021-08-09 19:35:16",
      "modified": "2021-08-09 19:35:16",
      "end": "00:00:00",
      "end_date": "2015-12-31",
      "is_multi_day": false
    },
    "location": null
  },
  "message": "Event added."
}
Language
Authentication
Basic
base64
:
Response
Click Try It! to start a request and see the response here!