POST
/
events
Create event
curl --request POST \
  --url https://api.smokeball.com/events \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "matterId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "subject": "Subject",
  "description": "Description",
  "location": "Location",
  "allDay": false,
  "nonBillable": false,
  "eventType": 0,
  "attendees": [
    "<string>"
  ],
  "externalAttendees": [
    "<string>"
  ],
  "startTime": "2000-01-01T20:00:00",
  "endTime": "2000-01-01T20:00:00",
  "timeZone": "Australia/Sydney",
  "additionalData": {}
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Body

​
matterId
string | null

Matter Id.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

​
subject
string | null

Subject of event.

Example:

"Subject"

​
description
string | null

Description of event.

Example:

"Description"

​
location
string | null

Location of event.

Example:

"Location"

​
allDay
boolean

Whether or not the event is all day.

Example:

false

​
nonBillable
boolean

Whether or not the event is billable. Note events with a duration greater than 12 hours automatically become non-billable.

Example:

false

​
eventType
enum<integer>

The type of the event.

We currently support create and updates requests for non recurring events (EventType = 0). The type of the event.

Possible values: Non Recurring Event = 0, Recurring Pattern Series = 1, Single Recurring Occurrence = 2, Modified Recurring Occurrence = 3, Deleted Recurring Occurrence = 4

Available options:
0,
1,
2,
3,
4
Example:

0

​
attendees
string[] | null

The staff Ids of the attendees of the event.

​
externalAttendees
string[] | null

The contact Ids of the external or third party attendees of the event.

The contacts must be of Person type and must be part of the matter.

​
startTime
string<date-time>

Start date and time of the event. Supported date format is ISO YYYY-MM-DDThh:mm:ss. Note: date and time will correlate with the time zone provided.

Example:

"2000-01-01T20:00:00"

​
endTime
string<date-time>

End date and time of the event. Supported date format is ISO YYYY-MM-DDThh:mm:ss. Note: date and time will correlate with the time zone provided.

Example:

"2000-01-01T20:00:00"

​
timeZone
string | null

Time zone of the event for determining the start time and end time. Time zones are expected in the IANA time zone format. For a list of valid time zones, see https://nodatime.org/TimeZones.

Example:

"Australia/Sydney"

​
additionalData
object | null

Collection of key value pairs to update file meta data.

Response

When request is accepted. Returns a hypermedia 'Link' object of the event to be created.

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET