Skip to content

IdentifiedAppointment

Appointment record with the identifier required by list and mutation responses.

Properties

Property Type Required Description
id any of: string, number Yes Connector appointment identifier.
thirdPartyAppointmentId any of: string or null, number or null No CRM-native appointment identifier used when opening the record in the CRM.
title string or null No Appointment title.
description string or null No Canonical appointment description returned by list operations.
summary string or null No Compatibility alias returned by some create, update, and refresh connectors.
participantName string or null No Compatibility display name for the primary participant.
startTimeUtc string · date-time or null No Appointment start timestamp, including its UTC offset. Pattern: ^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z\|([+-](?:[01]\d\|2[0-3]):[0-5]\d)))$.
durationMinutes number or null No Appointment duration in minutes. Minimum: 0.
status string or null No Connector-specific appointment status.
contactId any of: string or null, number or null No Primary related CRM contact identifier.
contactType string or null No Primary related CRM contact type.
attendees array of AppointmentAttendee No Normalized appointment attendees.
attendeeIds array of any of: string, number No Compatibility representation returned by connectors that do not provide attendee objects.

Example

{
  "id": "string",
  "thirdPartyAppointmentId": "string",
  "title": "string",
  "description": "string",
  "summary": "string",
  "participantName": "string",
  "startTimeUtc": "2026-01-01T00:00:00Z",
  "durationMinutes": 0.0,
  "status": "string",
  "contactId": "string",
  "contactType": "string",
  "attendees": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "status": "string",
      "email": "string"
    }
  ]
}