CRM

Send an outbound email via the user's connected Gmail or Outlook

postapi.modelmatch.com/v1/crm/email/send

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

attachmentsobject[]

Show child attributes

base64stringrequired

filenamestringrequired

mimeTypestringrequired

bccstring[]

ccstring[]

entityIdstringrequired

htmlstringrequired

organizationIdstring

providerenum | null

Options:googlemicrosoftnull

subjectstringrequired

textstringrequired

tostring[]required

Responses

200objectSent, or needs-connect when no send connector is available.

Show attributes

providerenum | nullrequired

Options:googlemicrosoftnull

resultenumrequired

Options:sentneeds-connect

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

502objectUpstream provider error.

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

curl -X POST "https://api.modelmatch.com/v1/crm/email/send" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>",
    "html": "<string>",
    "subject": "<string>",
    "text": "<string>",
    "to": [
      "<string>"
    ],
    "provider": "google",
    "organizationId": "<string>"
  }'

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

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

const { data, error } = await Crm.sendCrmEmail({
  body: {
    entityId: "<string>",
    html: "<string>",
    subject: "<string>",
    text: "<string>",
    to: [
      "<string>"
    ],
    provider: "google",
    organizationId: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/email/send",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "entityId": "<string>",
        "html": "<string>",
        "subject": "<string>",
        "text": "<string>",
        "to": [
            "<string>"
        ],
        "provider": "google",
        "organizationId": "<string>"
    },
)
data = res.json()

200 response

{
  "provider": "google",
  "result": "sent"
}