Skip to content
Lightfield Lightfield
API Reference
Meeting

Create a meeting

$ lightfield meeting create
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
--fields: object { "$endDate", "$startDate", "$title", 5 more }

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.

--auto-create-records: optional boolean

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

--relationships: optional object { "$transcript" }

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

ReturnsExpand Collapse
meeting_create_response: object { id, accessLevel, createdAt, 6 more }
id: string

Unique identifier for the entity.

accessLevel: "FULL" or "METADATA"

The caller’s resolved access level for this meeting.

"FULL"
"METADATA"
createdAt: string

ISO 8601 timestamp of when the entity was created.

fields: map[object { value, valueType } ]

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 or number or boolean or 3 more

The field value, or null if unset.

union_member_0: string
union_member_1: number
union_member_2: boolean
union_member_3: array of string
Address: object { city, country, latitude, 5 more }
city: optional string

City name.

country: optional string

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

latitude: optional number

Latitude coordinate.

longitude: optional number

Longitude coordinate.

postalCode: optional string

Postal or ZIP code.

state: optional string

State or province.

street: optional string

Street address line 1.

street2: optional string

Street address line 2.

FullName: object { firstName, lastName }
firstName: optional string

The contact’s first name.

lastName: optional string

The contact’s last name.

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

The data type of the field.

"ADDRESS"
"CHECKBOX"
"CURRENCY"
"DATETIME"
"EMAIL"
"FULL_NAME"
"MARKDOWN"
"MULTI_SELECT"
"NUMBER"
"SINGLE_SELECT"
"SOCIAL_HANDLE"
"TELEPHONE"
"TEXT"
"URL"
objectType: "meeting"

Always meeting.

"meeting"
relationships: map[object { cardinality, objectType, values } ]

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 of string

IDs of the related entities.

updatedAt: string

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

externalId: optional string

External identifier for the entity, or null if unset.

Create a meeting

lightfield meeting create \
  --api-key 'My API Key' \
  --fields '{$endDate: $endDate, $startDate: $startDate, $title: $title}'
{
  "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"
}