COcoevera
Activity

Appointments.batch_create_or_update

Creates or updates Appointment records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/Appointments/batch-modify

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

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.

idstring uuid

ID of object to update.

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

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.