calendar

[DRAFT] Update Personal Appointment

Changed on

[DRAFT] Use this endpoint to update an appointment(Personal type) from an existing calendar.

put/calendars/{calendarId}/appointments/{appointmentId}

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/calendars/{calendarId}/appointments/{appointmentId}
  • Auth
    HTTP bearer

Path parameters

calendarIdstring uuid required

The calendar's unique identifier

appointmentIdstring uuid required

The appointment's unique identifier

Request body

titlestring required

The title of the calendar event.

shareWithCustomerPortalboolean

If the event is shared with the customer portal.

notificationMessagestring

The message to be send to the appointment's attendees.

jobIdstring uuid

The unique GUID of the job associated with the event, if any.

locationstring

The address where the appointment is to take place.

detailsstring

other information related to the appointment.

attendeesstring[]

The Ids of the users that will attend the appointment.

Example request

{
  "title": "Initial Appointment",
  "notificationMessage": "This is a specific message for attendees.",
  "jobId": "b4c09ad6-1d53-4a34-8a45-d989660e12d8",
  "location": "123 Pleasant Grove Road, \\nACity, IL, 12345",
  "details": "Customer contact information:\\nCompany Name- Contact Name\\nJob: N/A\\n1234 Pleasant Grove Road, \\nACity, IL, 12345\\n(555) 123-45671 - mobile - Primary\\nmyemail@myprovider.net - Primary\\n",
  "eventDateTime": {
    "start": "2026-01-10T12:00:00Z",
    "end": "2026-01-10T13:00:00Z",
    "recurrence": {
      "recurrenceType": "Daily",
      "daysOfWeek": [
        "Monday"
      ],
      "repeatEvery": 2,
      "repeatingType": "Never",
      "stopDate": "2026-01-07T00:00:00Z",
      "numberOfOcurrences": 2
    }
  },
  "attendees": [
    "2cd61531-9881-4900-852b-3a6fd714899c",
    "957cb4a1-baa5-4635-a001-ae53e25c16e4",
    "ade522e8-1f61-4884-8727-6967fed0d412"
  ]
}

Response

No Content

Changes