CRM

Create a meeting (optionally syncing it to a calendar provider)

postapi.modelmatch.com/v1/crm/meetings

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

descriptionstring | null

endAtnumberrequired

entityIdstringrequired

inviteeEmailstring | null

inviteeNamestring | null

listIdstring

locationstring | null

providerenum | null

Options:googlemicrosoftnull

recordNamestring

recordUrlstring

startAtnumberrequired

teammateUserIdsstring[]

timezonestring | null

titlestringrequired

Responses

201objectCreated.

Show attributes

dataobjectrequired

Show child attributes

attendeesobject[]required

Show child attributes

emailstringrequired

idstringrequired

isOrganizerbooleanrequired

kindenumrequired

Options:recordteammateexternal

namestring | nullrequired

responseStatusenumrequired

Options:needsActionaccepteddeclinedtentative

userIdstring | nullrequired

calendarEventIdstring | nullrequired

calendarHtmlLinkstring | nullrequired

calendarIdstring | nullrequired

calendarProviderenum | nullrequired

Options:googlemicrosoftnull

calendarSyncedAtnumber | nullrequired

cancelReasonenum | nullrequired

Options:cancelledno_shownull

cancelledAtnumber | nullrequired

completedAtnumber | nullrequired

completedByenum | nullrequired

Options:usersystemnull

createdAtnumberrequired

createdByUserIdstringrequired

descriptionstring | nullrequired

endAtnumberrequired

entityIdstringrequired

icalUidstring | nullrequired

idstringrequired

listIdstring | nullrequired

locationstring | nullrequired

startAtnumberrequired

statusenumrequired

Options:scheduledcancelledcompleted

timezonestring | nullrequired

titlestringrequired

needsConnectenum | null

Options:googlemicrosoftnull

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectNot found

413objectResponse payload too large — detail endpoint capped to fit Lambda response limits

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X POST "https://api.modelmatch.com/v1/crm/meetings" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "endAt": 123.45,
    "entityId": "<string>",
    "startAt": 123.45,
    "title": "<string>",
    "provider": "google",
    "description": "<string>",
    "inviteeEmail": "<string>",
    "inviteeName": "<string>",
    "listId": "<string>",
    "location": "<string>"
  }'

import { createClient, Crm } from "@model-match/api";

createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await Crm.createCrmMeeting({
  body: {
    endAt: 123.45,
    entityId: "<string>",
    startAt: 123.45,
    title: "<string>",
    provider: "google",
    description: "<string>",
    inviteeEmail: "<string>",
    inviteeName: "<string>",
    listId: "<string>",
    location: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/meetings",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "endAt": 123.45,
        "entityId": "<string>",
        "startAt": 123.45,
        "title": "<string>",
        "provider": "google",
        "description": "<string>",
        "inviteeEmail": "<string>",
        "inviteeName": "<string>",
        "listId": "<string>",
        "location": "<string>"
    },
)
data = res.json()

201 response

{
  "data": {
    "attendees": [
      {
        "email": "<string>",
        "id": "<string>",
        "isOrganizer": true,
        "kind": "record",
        "name": "<string>",
        "responseStatus": "needsAction",
        "userId": "<string>"
      }
    ],
    "calendarEventId": "<string>",
    "calendarHtmlLink": "<string>",
    "calendarId": "<string>",
    "calendarProvider": "google",
    "calendarSyncedAt": 123.45,
    "cancelReason": "cancelled",
    "cancelledAt": 123.45,
    "completedAt": 123.45,
    "completedBy": "user",
    "createdAt": 123.45,
    "createdByUserId": "<string>",
    "description": "<string>",
    "endAt": 123.45,
    "entityId": "<string>",
    "icalUid": "<string>",
    "id": "<string>",
    "listId": "<string>",
    "location": "<string>",
    "startAt": 123.45
  },
  "needsConnect": "google"
}