AppointmentMeeting

An appointment meeting represents the conferencing details for an appointment. Meetings are created asynchronously after an appointment is scheduled, so the status field reflects where the meeting is in its lifecycle. Meeting details such as join_url are populated only once the status is created.

conferencing_providerstringnullablerequired

The conferencing provider for the meeting.

Example: zoom_admin

error_messagestringnullablerequired

The most-recent failure reason, if the meeting is in a failed state.

external_meeting_idstringnullablerequired

The provider's identifier for the meeting.

Example: 82912345678

host_urlurinullablerequired

The URL the host uses to start the meeting.

idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^amtg_\w{12}$

join_urlurinullablerequired

The URL attendees use to join the meeting.

objectstringrequired

String representing the object's type.

Possible values: [appointment_meeting]

passwordstringnullablerequired

The meeting password, if any.

statusstringrequired

The current state of the meeting. Lifecycle:

• pending — meeting creation has not yet been attempted
• created — meeting was successfully created with the conferencing provider
• failed — most-recent attempt failed; see error_message for details
• skipped — meeting creation was skipped (no conferencing configured)
• update_pending — meeting update is pending after a reschedule
• cancel_pending — meeting cancellation is pending after appointment cancel
• canceled — meeting was successfully canceled with the conferencing provider

Possible values: [pending, created, failed, skipped, update_pending, cancel_pending, canceled]

AppointmentMeeting

{
  "conferencing_provider": "zoom_admin",
  "error_message": null,
  "external_meeting_id": "82912345678",
  "host_url": "https://zoom.us/s/82912345678",
  "id": "amtg_a1b2c3d4e5f6",
  "join_url": "https://zoom.us/j/82912345678",
  "object": "appointment_meeting",
  "password": "abc123",
  "status": "created"
}