Create a meeting

client.meeting.create(, ?): MeetingCreateResponse { id, accessLevel, createdAt, 6 more }

POST/v1/meetings

Creates a new meeting record. This endpoint only supports creation of meetings in the past. The $title, $startDate, and $endDate fields are required. Only the $transcript relationship is writable on create; all other meeting relationships are system-managed. The response is privacy-aware and includes a read-only accessLevel. See Uploading meeting transcripts for the full file upload and transcript attachment flow.

Supports idempotency via the Idempotency-Key header.

Required scope: meetings:create

Rate limit category: Write

ParametersExpand Collapse

body: MeetingCreateParams { fields, autoCreateRecords, relationships }

fields: Fields

Field values for the new MANUAL meeting. System fields use a $ prefix (for example $title, $startDate, $endDate). Required: $title, $startDate, and $endDate. $organizerEmail accepts a single email address when provided; $attendeeEmails accepts an array of email addresses. See Fields and relationships for value type details.

"$endDate": string

The end time of the meeting in ISO 8601 format. Must be in the past.

"$startDate": string

The start time of the meeting in ISO 8601 format. Must be in the past.

"$title": string

The title of the meeting.

"$attendeeEmails"?: Array<string>

A list of attendee email addresses.

"$description"?: string | null

A description of the meeting.

"$meetingUrl"?: string | null

The URL for the meeting.

"$organizerEmail"?: string | null

The email address of the meeting organizer. This field accepts a single email address.

"$privacySetting"?: "FULL" | "METADATA" | null

The privacy setting for the meeting (FULL or METADATA).

Accepts one of the following:

"FULL"

"METADATA"

autoCreateRecords?: boolean

When true, the initial post-create meeting sync may auto-create account and contact records for external attendees.

relationships?: Relationships

Relationships to set on the new meeting. Only $transcript is writable on create; all other meeting relationships are system-managed.

"$transcript": string | Array<string>

The ID of the file to attach as the meeting transcript when creating the meeting. Only one transcript can be attached to a meeting.

Accepts one of the following:

string

Array<string>

ReturnsExpand Collapse

MeetingCreateResponse { id, accessLevel, createdAt, 6 more }

id: string

Unique identifier for the entity.

accessLevel: "FULL" | "METADATA"

The caller's resolved access level for this meeting.

Accepts one of the following:

"FULL"

"METADATA"

createdAt: string

ISO 8601 timestamp of when the entity was created.

fields: Record<string, Fields>

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

value: string | number | boolean | 3 more | null

The field value, or null if unset.

Accepts one of the following:

string

number

boolean

Array<string>

Address { city, country, latitude, 5 more }

city?: string | null

City name.

country?: string | null

2-letter ISO 3166-1 alpha-2 country code.

latitude?: number | null

Latitude coordinate.

longitude?: number | null

Longitude coordinate.

postalCode?: string | null

Postal or ZIP code.

state?: string | null

State or province.

street?: string | null

Street address line 1.

street2?: string | null

Street address line 2.

FullName { firstName, lastName }

firstName?: string | null

The contact's first name.

lastName?: string | null

The contact's last name.

valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 11 more

The data type of the field.

Accepts one of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

httpLink: string | null

URL to view the entity in the Lightfield web app, or null.

objectType: "meeting"

Always meeting.

relationships: Record<string, Relationships>

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

cardinality: string

Whether the relationship is has_one or has_many.

objectType: string

The type of the related object (e.g. account, contact).

values: Array<string>

IDs of the related entities.

updatedAt: string | null

ISO 8601 timestamp of when the entity was last updated, or null.

externalId?: string | null

External identifier for the entity, or null if unset.

Create a meeting

import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const meetingCreateResponse = await client.meeting.create({
  fields: {
    $endDate: '$endDate',
    $startDate: '$startDate',
    $title: '$title',
  },
});

console.log(meetingCreateResponse.id);

{
  "id": "id",
  "accessLevel": "FULL",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "objectType": "meeting",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}

Returns Examples

{
  "id": "id",
  "accessLevel": "FULL",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "objectType": "meeting",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}