POST /calendarEvents — fergus-api

Calendar Events

Creates a new calendar event.

eventType must be one of : JOB_PHASE, QUOTE, ESTIMATE, OTHER.
- JOB_PHASE: Event type for a job phase. jobPhaseId must be provided.
- QUOTE: Event type for a quote. jobId must be provided.
- ESTIMATE: Event type for an estimate. jobId must be provided.
- OTHER: General event type. Default value.
frequency must be one of : DAILY, WEEKLY, MONTHLY, YEARLY, NEVER.
- DAILY: Repeats every day.
- WEEKLY: Repeats every week.
- MONTHLY: Repeats every month.
- YEARLY: Repeats every year.
- NEVER: Does not repeat. Default value.
If the event is recurring, frequency is not NEVER.
- interval controls how often the event repeats,
  - Example: WEEKLY with an interval = 2, the event repeats every 2 weeks.
  - Default is 1.
- repeatEndType must be one of:
  - NEVER: Repeats indefinitely. Default value.
  - ON_DATE: Repeats until the specified repeatEndDate.
  - AFTER: Repeats for the specified repeatCount number of occurrences.
- If repeatEndType = ON_DATE, the repeatEndDate must be provided.
- If repeatEndType = AFTER, the repeatCount must be provided.
If userId or linkedUserIds is provided, the event is assigned to those user(s). Otherwise, the event is unassigned.

post/calendarEvents

Request body

userIdnumber

linkedUserIdsnumber[]

startTimestring date-time required

endTimestring date-time required

jobIdnumber

jobPhaseIdnumber

eventTitlestring required

eventType'JOB_PHASE' | 'QUOTE' | 'ESTIMATE' | 'OTHER' required

descriptionstring

frequency'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY' | 'NEVER'

intervalnumber

repeatEndType'NEVER' | 'ON_DATE' | 'AFTER'

repeatEndDatestring date nullable

repeatCountnumber

{
  "startTime": "2021-01-01T07:00:00.000Z",
  "endTime": "2021-01-01T17:00:00.000Z",
  "repeatEndDate": "2021-01-01"
}

Resource created successfully

resultstring required

{
  "data": [
    {
      "startTime": "2021-01-01T07:00:00.000Z",
      "endTime": "2021-01-01T17:00:00.000Z"
    }
  ]
}