Create an event

Updated:

POST/calendar/{connection_id}/event

Creates a CalendarEvent. Provide the unified CalendarEvent fields in the request body; they are mapped to the provider's API. Returns the created CalendarEvent.

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Payload

idstring
created_atstring
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
calendar_idstring
(reference to CalendarCalendar)
subjectstring
start_atstring
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_all_dayboolean
timezonestring
notesstring
locationstring
is_freeboolean
is_privateboolean
status enum
Valid values:
"CANCELED"
"CONFIRMED"
"TENTATIVE"
organizerobject
attendees array
recurring_event_idstring
(reference to CalendarEvent)
recurrence array
web_urlstring
has_conferenceboolean
conference array
attachments array
send_notificationsboolean
matter_idstring
pointer to Legal Matter
metadata array
room_idsstring array
pointers to Calendar Rooms booked for this event

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstringNo(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstringNo(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
calendar_idstringNo(reference to CalendarCalendar)
subjectstringNo
start_atstringNo(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstringNo(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_all_daybooleanNo
timezonestringNo
notesstringNo
locationstringNo
is_freebooleanNo
is_privatebooleanNo
statusenumNoValues: CANCELED, CONFIRMED, TENTATIVE
organizerobjectNo
organizer.user_idstringNo(reference to HrisEmployee)
organizer.emailstringNo
organizer.namestringNo
organizer.statusenumNoValues: ACCEPTED, REJECTED, TENTATIVE
organizer.requiredbooleanNo
organizer.is_cohostbooleanNo
attendeesCalendarAttendee[]No
attendees[].user_idstringNo(reference to HrisEmployee)
attendees[].emailstringNo
attendees[].namestringNo
attendees[].statusenumNoValues: ACCEPTED, REJECTED, TENTATIVE
attendees[].requiredbooleanNo
attendees[].is_cohostbooleanNo
recurring_event_idstringNo(reference to CalendarEvent)
recurrenceCalendarEventRecurrence[]No
recurrence[].frequencyenumNoValues: DAILY, WEEKLY, MONTHLY, YEARLY
recurrence[].intervalnumberNohow many "units" between occurrences, defaults to 1
recurrence[].countnumberNohow many occurrences, defaults to undefined (no limit)
recurrence[].end_atstring (date-time)Nountil date, defaults to undefined (no end date) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
recurrence[].on_daysenum[]Nodays of the week to repeat on, defaults to undefined (every day), only used if frequency is WEEKLY Values: SU, MO, TU, WE, TH, FR, SA
recurrence[].on_monthsobjectNomonths of the year to repeat on, defaults to undefined (every month), only used if frequency is YEARLY, January is 1
recurrence[].on_month_daysobjectNodays of the month to repeat on, defaults to undefined (every day), only used if frequency is MONTHLY
recurrence[].on_weeksobjectNoweek ordinals for BYDAY (e.g., -1 for last, -2 for second-to-last, 1 for first, 2 for second), only used with on_days. 0 is used for days without week ordinals.
recurrence[].on_year_daysobjectNodays of the year to repeat on, defaults to undefined (every day), only used if frequency is YEARLY
recurrence[].week_startenumNoweek start day, defaults to undefined (no week start day) Values: SU, MO, TU, WE, TH, FR, SA
recurrence[].excluded_datesobjectNodates to exclude from the recurrence, defaults to undefined (no exclusions)
recurrence[].included_datesobjectNodates to include in the recurrence, defaults to undefined (no inclusions)
recurrence[].timezonestringNotimezone, defaults to undefined (no timezone)
web_urlstringNo
has_conferencebooleanNo
conferenceCalendarConference[]No
conference[].conference_identifierstringNo
conference[].urlstringNo
conference[].labelstringNo
conference[].telephonestringNo
conference[].participant_access_codestringNo
conference[].host_access_codestringNo
conference[].notesstringNo
conference[].country_codestringNoISO 2-digit country code
conference[].region_codestringNoISO 2-digit region code
attachmentsCalendarAttachment[]No
attachments[].idstringNoID for the storage_fileget endpoint
attachments[].namestringNo
attachments[].mime_typestringNo
attachments[].download_urlstringNo
send_notificationsbooleanNo
matter_idstringNopointer to Legal Matter
metadataCalendarMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo
room_idsstring[]Nopointers to Calendar Rooms booked for this event

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'POST',
  url: 'https://api.unified.to/calendar/5de520f96e439b002043d8dc/event',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?