v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Events

Create event

Create new event.

post/events

Request body

matterIdstring nullable

Matter Id.

subjectstring nullable

Subject of event.

descriptionstring nullable

Description of event.

locationstring nullable

Location of event.

allDayboolean

Whether or not the event is all day.

nonBillableboolean

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

type'Normal' | 'Pattern' | 'Occurrence' | 'ChangedOccurrence' | 'DeletedOccurrence'

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

eventType'Normal' | 'Pattern' | 'Occurrence' | 'ChangedOccurrence' | 'DeletedOccurrence'

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

attendeesstring[] nullable

The staff Ids of the attendees of the event.

externalAttendeesstring[] nullable

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.

startTimestring 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.

endTimestring 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.

timeZonestring nullable

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.

additionalDataobject nullable

Collection of key value pairs to update file meta data.

Example request

{
  "matterId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "subject": "Subject",
  "description": "Description",
  "location": "Location",
  "startTime": "2000-01-01T20:00:00",
  "endTime": "2000-01-01T20:00:00",
  "timeZone": "Australia/Sydney"
}

Response

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

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable