CRM

Hang up an in-flight call

patchapi.modelmatch.com/v1/crm/calls

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

idstringrequired

Responses

200objectThe call row.

Show attributes

dataobjectrequired

Show child attributes

aiActionsobject[] | nullrequired

Show child attributes

dueInDaysnumber

durationMinutesnumber

startInDaysnumber

titlestringrequired

typeenumrequired

Options:taskmeeting

aiAnalyzedAtnumber | nullrequired

aiLabelstring | nullrequired

aiSentimentenum | nullrequired

Options:positiveneutralnegativenull

aiSummarystring | nullrequired

answeredByenum | nullrequired

Options:humanmachinefaxunknownnull

createdAtnumberrequired

durationSecondsnumber | nullrequired

endedAtnumber | nullrequired

endedByenum | nullrequired

Options:callerremotesystemnull

entityIdstringrequired

fromNumberstringrequired

idstringrequired

organizationIdstringrequired

recordingEnabledbooleanrequired

recordingSidstring | nullrequired

startedAtnumber | nullrequired

statusstringrequired

toNumberstringrequired

transcriptobject[] | nullrequired

Show child attributes

speakerenumrequired

Options:usercontact

textstringrequired

transcriptSidstring | nullrequired

transcriptStatusenum | nullrequired

Options:pendingprocessingcompletedfailedabsentvoicemailnull

twilioCallSidstring | nullrequired

userIdstringrequired

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 PATCH "https://api.modelmatch.com/v1/crm/calls" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "<string>"
  }'

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

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

const { data, error } = await Crm.hangupCrmCall({
  body: {
    id: "<string>"
  }
});

import os
import requests

res = requests.patch(
    "https://api.modelmatch.com/v1/crm/calls",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "id": "<string>"
    },
)
data = res.json()

200 response

{
  "data": {
    "aiActions": [
      {
        "dueInDays": 123.45,
        "durationMinutes": 123.45,
        "startInDays": 123.45,
        "title": "<string>",
        "type": "task"
      }
    ],
    "aiAnalyzedAt": 123.45,
    "aiLabel": "<string>",
    "aiSentiment": "positive",
    "aiSummary": "<string>",
    "answeredBy": "human",
    "createdAt": 123.45,
    "durationSeconds": 123.45,
    "endedAt": 123.45,
    "endedBy": "caller",
    "entityId": "<string>",
    "fromNumber": "<string>",
    "id": "<string>",
    "organizationId": "<string>",
    "recordingEnabled": true,
    "recordingSid": "<string>",
    "startedAt": 123.45,
    "status": "<string>",
    "toNumber": "<string>",
    "transcript": [
      {
        "speaker": "user",
        "text": "<string>"
      }
    ]
  }
}