CRM

Create a task on a record

postapi.modelmatch.com/v1/crm/tasks

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

allDayboolean

assigneeUserIdstring

bodystring | null

dueAtnumber | null

entityIdstringrequired

grantAccessboolean

listIdstring

titlestringrequired

Responses

200objectSuccess.

Show attributes

dataone ofrequired

Show child attributes

Option 1object

Show child attributes

allDaybooleanrequired

assigneeUserIdstringrequired

bodystring | nullrequired

calendarEventIdstring | nullrequired

calendarProviderenum | nullrequired

Options:googlemicrosoftnull

cancelledAtnumber | nullrequired

completedAtnumber | nullrequired

createdAtnumberrequired

createdByUserIdstringrequired

dueAtnumber | nullrequired

entityIdstringrequired

idstringrequired

listIdstring | nullrequired

statusenumrequired

Options:opencompletedcancelled

titlestringrequired

Option 2object

Show child attributes

canSharebooleanrequired

createdboolean

needsShareenumrequired

Options:true

updatedboolean

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/tasks" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>",
    "title": "<string>",
    "allDay": true,
    "assigneeUserId": "<string>",
    "body": "<string>",
    "dueAt": 123.45,
    "grantAccess": true,
    "listId": "<string>"
  }'

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

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

const { data, error } = await Crm.createCrmTask({
  body: {
    entityId: "<string>",
    title: "<string>",
    allDay: true,
    assigneeUserId: "<string>",
    body: "<string>",
    dueAt: 123.45,
    grantAccess: true,
    listId: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/tasks",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "entityId": "<string>",
        "title": "<string>",
        "allDay": True,
        "assigneeUserId": "<string>",
        "body": "<string>",
        "dueAt": 123.45,
        "grantAccess": True,
        "listId": "<string>"
    },
)
data = res.json()

200 response

{
  "data": {
    "allDay": true,
    "assigneeUserId": "<string>",
    "body": "<string>",
    "calendarEventId": "<string>",
    "calendarProvider": "google",
    "cancelledAt": 123.45,
    "completedAt": 123.45,
    "createdAt": 123.45,
    "createdByUserId": "<string>",
    "dueAt": 123.45,
    "entityId": "<string>",
    "id": "<string>",
    "listId": "<string>",
    "status": "open",
    "title": "<string>"
  }
}