Update a meeting

client.meeting.update(, , ?): MeetingUpdateResponse { id, accessLevel, createdAt, 6 more }

POST/v1/meetings/{id}

Updates an existing meeting by ID. Only included fields and relationships are modified.

Only fields.$privacySetting, fields.$attendeeEmails and relationships.$transcript.replace are writable. $attendeeEmails replaces the full attendee list and only works on meetings that have ended. Adding an address on the workspace blocklist or a teammate’s do-not-track list hides the meeting after the next sync, and only an admin can bring it back by removing the blocklist entry; the response lists manual changes in the read-only $manuallyAddedAttendeeEmails and $manuallyRemovedAttendeeEmails. $transcript is the file ID of the canonical transcript. $transcripts lists the file ID of every transcript on the meeting. Use $transcript.replace to make that file canonical. A file that is not already on the meeting is attached first. Clearing or removing $transcript is not supported. The $account and $opportunity relationships are read-only and are derived from the meeting’s $contact attendees and the accounts/opportunities those contacts belong to. 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:update

Rate limit category: Write

ParametersExpand Collapse

id: string

Unique identifier of the meeting to update.

body: MeetingUpdateParams { fields, relationships }

fields?: Fields

Field values to update. Only $privacySetting, $attendeeEmails, $meetingPrep and $postMeetingSummary are writable, and omitted fields are left unchanged.

"$attendeeEmails"?: Array<string>

The full list of attendee email addresses, up to 500. Only meetings that have ended can be edited.

"$meetingPrep"?: string | null

The meeting prep, as Markdown. Lightfield regenerates it as new activity arrives, which replaces an edit; null or an empty string clears it until then.

"$postMeetingSummary"?: string | null

The meeting summary, as Markdown. Lightfield regenerates it as new activity arrives, which replaces an edit; null or an empty string clears it until then.

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

The privacy setting for the meeting.

One of the following:

"FULL"

"METADATA"

relationships?: Relationships

Relationship operations to apply. Only $transcript.replace is supported; removing or clearing $transcript is not supported.

"$transcript"?: Transcript { replace }

replace: string

The file ID to make the canonical transcript. A file that is not already a transcript on the meeting is attached first.

ReturnsExpand Collapse

MeetingUpdateResponse { id, accessLevel, createdAt, 6 more }

id: string

Unique identifier for the entity.

accessLevel: "FULL" | "METADATA"

The caller’s resolved access level for this meeting.

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.

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" | 12 more

The data type of the field.

One of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

"HTML"

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). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

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.

directions?: Directions { asDestination, asSource }

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

asDestination: AsDestination { cardinality, values }

The current record is the destination (incoming) endpoint.

cardinality: "HAS_ONE" | "HAS_MANY"

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: Array<string>

IDs of the related entities in this direction.

asSource: AsSource { cardinality, values }

The current record is the source (outgoing) endpoint.

cardinality: "HAS_ONE" | "HAS_MANY"

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:

"HAS_ONE"

"HAS_MANY"

values: Array<string>

IDs of the related entities in this direction.

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.

Update a meeting

import Lightfield from 'lightfield';

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

const meetingUpdateResponse = await client.meeting.update('id');

console.log(meetingUpdateResponse.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"
      ],
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "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"
      ],
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        }
      }
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}