Max Meetings

Create a meeting

Changed on

Creates a manually-tracked meeting. Meetings normally arrive from the connected calendar, so use this for calls that are not on a calendar. Supplying meetingUrl lets the notetaker join at the scheduled time. Requires a USER API key.

post/public/v1/max/meetings

Request

Request body

titlestring
meetingUrlstring uri
platform'ZOOM' | 'GOOGLE_MEET' | 'MICROSOFT_TEAMS' | 'WEBEX' | 'SLACK_HUDDLE' | 'OTHER'
captureMethod'BOT' | 'DESKTOP_SDK'
scheduledAtstring date-time
doNotRecordboolean
folderIdstring
metadataobject

Example request

{
  "title": "example",
  "meetingUrl": "https://api.example.com/contacts/123",
  "platform": "ZOOM",
  "captureMethod": "BOT",
  "scheduledAt": "2024-01-01T12:00:00.000Z",
  "folderId": "example"
}

Response

Meeting created

oktrue required

Example response

{
  "ok": true,
  "data": {
    "id": "example",
    "title": "example",
    "meetingUrl": "example",
    "platform": "ZOOM",
    "source": "CALENDAR_SYNC",
    "status": "UPCOMING",
    "captureMethod": "BOT",
    "scheduledAt": "example",
    "scheduledEndAt": "example",
    "startedAt": "example",
    "endedAt": "example",
    "duration": 1,
    "provider": "RECALL",
    "transcriptionProvider": "RECALL",
    "transcriptStatus": "PENDING",
    "folderId": "example",
    "maxUserProfileId": 1,
    "createdAt": "example",
    "updatedAt": "example",
    "shareToken": "example",
    "participants": [
      {
        "id": "example",
        "name": "example",
        "email": "example",
        "joinedAt": "example",
        "leftAt": "example",
        "speakingDuration": 1,
        "wordCount": 1,
        "userId": 1,
        "maxContactId": "example",
        "user": {
          "avatar": "example"
        },
        "person": {
          "tableId": 1,
          "rowId": "example"
        },
        "createdAt": "example"
      }
    ],
    "recording": {
      "id": "example",
      "recordingMode": "TRANSCRIPT_ONLY",
      "videoStoragePath": "example",
      "audioStoragePath": "example",
      "videoUrl": "example",
      "audioUrl": "example",
      "createdAt": "example"
    },
    "notes": {
      "id": "example",
      "rawNotes": "example",
      "enhancedNotes": "example",
      "enhancedStatus": "PENDING",
      "actionItems": [
        {
          "id": "example",
          "text": "example",
          "position": 1
        }
      ],
      "templateId": 1,
      "createdAt": "example",
      "updatedAt": "example"
    },
    "folder": {
      "id": "example",
      "name": "example",
      "createdBy": {
        "id": 1,
        "firstName": "example",
        "lastName": "example",
        "email": "user@example.com",
        "avatar": "example"
      }
    }
  }
}

Changes