Create a new event. Requires events.create permission.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
with[] |
string[] | no | Include related resources in the response. Pass multiple values as separate query parameters (e.g., ?with[]=createdBy&with[]=updatedBy). One of: createdBy, updatedBy, organization, site, order, exceptions, assignments. |
Request body
Required.
application/json
allDaybooleandescriptionstringdurationMinutesinteger · requiredorderIdstring (uuid)recurringbooleanrrulestringsiteIdstring (uuid)startstring (date-time) · requiredtitlestring · requiredtypestring · requireduntilstring (date)
{
"allDay": false,
"description": "string",
"durationMinutes": 60,
"orderId": "string",
"recurring": false,
"rrule": "FREQ=WEEKLY;BYDAY=MO",
"siteId": "string",
"start": "2026-03-02 09:00:00",
"title": "Weekly Meeting",
"type": "scheduled_work",
"until": "2026-12-31"
}
Responses
| Status | Description |
|---|---|
| 201 | Event created |
| 403 | Forbidden |
| 422 | Validation error |
Response 201 body
dataobject · requiredmetaobject · required
{
"data": {
"id": "string",
"allDay": false,
"confirmedAt": "string",
"confirmedBy": {
"id": "019222d9-d87d-7724-bba6-ba91503ea311",
"firstName": "John",
"lastName": "Doe"
},
"createdAt": "2024-06-30T19:00:00Z",
"createdBy": {
"id": "019222d9-d87d-7724-bba6-ba91503ea311",
"firstName": "John",
"lastName": "Doe"
},
"description": "string",
"durationMinutes": 0,
"orderId": "string",
"organization": {
"id": "019222d9-d87d-7724-bba6-ba91503ea311",
"name": "ACME Corporation"
},
"recurring": false,
"rrule": "string",
"site": {
"id": "019222d9-d87d-7724-bba6-ba91503ea311",
"name": "Stockholm Office"
},
"start": "string",
"status": "draft",
"title": "string",
"type": "scheduled_work",
"until": "string",
"updatedAt": "2024-06-30T19:00:00Z",
"updatedBy": {
"id": "019222d9-d87d-7724-bba6-ba91503ea311",
"firstName": "John",
"lastName": "Doe"
}
},
"meta": {
"requestId": "019a3a60-6328-7075-8a41-76ff545ca5d3",
"userId": "019a3a60-929c-7820-9b35-bf79a8bf83a6",
"organizationId": "019a3a60-8175-7a68-88da-ecb4a7040b86"
}
}