Skip to main content
POST
/
events
Create Event
curl --request POST \
  --url https://api.roostedhr.com/api/1_12/events \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "date": "2023-12-25",
  "location": {
    "location_id": "<string>",
    "name": "<string>",
    "address": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "saved": "<string>"
  },
  "client_id": "<string>",
  "admin_comments": "<string>",
  "comments": "<string>",
  "custom_fields": [
    {
      "id": "<string>",
      "value": "<string>"
    }
  ]
}
'
123

​
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.
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[]

Response

Created

Created event ID