Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Activity

Appointments.update

Modifies Appointment or Appointments with given id(s)

patch/entities/Appointments/{id}

Path parameters

idstring uuid required

ID of Appointment to update

Query parameters

validation-levelinteger

Specify validation level of Appointment on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

media_transcription_idstring uuid

Id of the linked Media record holding the activity's call recording / transcription, when available.

activity_type_idstring uuid

Id of the appointment type.

currency_exchange_rates_list_idstring uuid

Id of the currency exchange rate list applied to this appointment.

descriptionstring

Free-form description of the appointment.

durationnumber double

Duration of the appointment, derived from start/end dates.

end_datestring date-time

End timestamp of the appointment.

invitees_can_editboolean

True when invitees are allowed to edit the appointment. Defaults to false.

is_recurrence_activeboolean

True when the recurrence series is still generating new occurrences. Read-only.

is_recurrence_exceptionboolean

True when this occurrence has been modified independently of the recurring series. Read-only.

locationstring

Free-text physical location of the appointment.

meeting_urlobject

Online meeting link associated with the appointment (join URL plus meeting type, e.g. Zoom, Teams). Empty when the appointment has no online meeting attached.

occurence_datestring date-time

Original date of this occurrence in the recurring series. Set automatically.

organizerstring

Email of the user organising the appointment. Set automatically and used as the reply-to address in invitation emails.

owner_idstring uuid

Id of the appointment owner.

recurrence_master_idstring uuid

Id of the master appointment.

recurrence_rulestring

iCalendar RRULE string describing the recurrence pattern (e.g. "FREQ=WEEKLY;BYDAY=MO,WE"). Empty for non-recurring appointments.

recurrence_tzidstring

IANA timezone the recurrence rule is evaluated in.

schedule_idstring uuid

Id of the appointment schedule.

schedule_tzidstring

IANA timezone the appointment was booked in (e.g. "Europe/Bratislava"). Used to evaluate availability against the schedule.

start_datestring date-time

Start timestamp of the appointment.

subjectstring

Short summary line shown in calendars and lists.

unit_idstring uuid

Id of the sales unit.

revisioninteger

Revision when entity was lastly changed.

exchange_entity_idstring

External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.

gapi_entity_idstring

External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.

o365_entity_idstring

External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.

Example request

{
  "media_transcription_id": "01234567-abcd-dcba-ffff-000000000000",
  "activity_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
  "description": "string",
  "end_date": "2019-01-01T00:00:00",
  "location": "string",
  "occurence_date": "2019-01-01T00:00:00",
  "organizer": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "recurrence_master_id": "01234567-abcd-dcba-ffff-000000000000",
  "recurrence_rule": "string",
  "recurrence_tzid": "string",
  "schedule_id": "01234567-abcd-dcba-ffff-000000000000",
  "schedule_tzid": "string",
  "start_date": "2019-01-01T00:00:00",
  "subject": "string",
  "unit_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1,
  "exchange_entity_id": "string",
  "gapi_entity_id": "string",
  "o365_entity_id": "string"
}

Response

Modification confirmation. Returns resulting Appointment

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "active_reminder": "2019-01-01T00:00:00",
    "media_transcription_id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "activity_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "end_date": "2019-01-01T00:00:00",
    "location": "string",
    "occurence_date": "2019-01-01T00:00:00",
    "organizer": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "recurrence_master_id": "01234567-abcd-dcba-ffff-000000000000",
    "recurrence_rule": "string",
    "recurrence_tzid": "string",
    "schedule_id": "01234567-abcd-dcba-ffff-000000000000",
    "schedule_tzid": "string",
    "start_date": "2019-01-01T00:00:00",
    "subject": "string",
    "table_name": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "status": 1,
    "exchange_entity_id": "string",
    "gapi_entity_id": "string",
    "o365_entity_id": "string",
    "formatted_name": "string",
    "modified_by_user": "2019-01-01T00:00:00"
  }
}