Skip to main content
POST
Create Event

Location

Provide the event location via the location object. To link an existing saved location, pass location_id. To create an inline location, provide name, address, city, and zip — set saved to "1" to save it for reuse.

Custom fields

Send custom fields as an array of { field_id, value } objects, where field_id is the custom field’s ID.

Areas

Assign areas to the event by passing an array of area IDs in the areas field. Invalid IDs return a 400 error.
The client_id field is optional. When provided, it links the event to an existing client record.

Authorizations

X-API-KEY
string
header
required

Body

application/json
name
string
required
date
string<date>
required
location
object
required
client_id
string
Pattern: ^[A-Za-z0-9]+
admin_comments
string
Maximum string length: 65535
comments
string
Maximum string length: 65535
custom_fields
object[]
areas
string[]

Area IDs to assign to the event. Invalid IDs return 400.

Response

Created

Created event ID