CRM

Replay a template's fields onto a list

postapi.modelmatch.com/v1/crm/lists/{listId}/apply-template

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

listIdstringrequired

Body application/json

libraryTemplateIdstring

templateIdstring

Responses

200objectFields that landed vs. were skipped (additive, idempotent).

Show attributes

dataobjectrequired

Show child attributes

appliedobject[]required

Show child attributes

configobject | nullrequired

idstringrequired

keystringrequired

labelstringrequired

listIdstring | nullrequired

objectTypeenumrequired

Options:peoplecompanies

optionsobject[] | nullrequired

scopeenumrequired

Options:objectlist

sortOrdernumberrequired

typeenumrequired

Options:textnumbercurrencydateselectmultiselecturlratingcheckboxstatustags

objectTypeMismatchboolean

skippedstring[]required

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/lists/<listId>/apply-template" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "libraryTemplateId": "<string>",
    "templateId": "<string>"
  }'

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

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

const { data, error } = await Crm.applyCrmListTemplate({
  path: {
    listId: "<listId>"
  },
  body: {
    libraryTemplateId: "<string>",
    templateId: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/lists/<listId>/apply-template",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "libraryTemplateId": "<string>",
        "templateId": "<string>"
    },
)
data = res.json()

200 response

{
  "data": {
    "applied": [
      {
        "config": {
          "key": null
        },
        "id": "<string>",
        "key": "<string>",
        "label": "<string>",
        "listId": "<string>",
        "objectType": "people",
        "options": [
          {
            "color": "<string>",
            "id": "<string>",
            "label": "<string>",
            "outcome": "won"
          }
        ],
        "scope": "object",
        "sortOrder": 123.45,
        "type": "text"
      }
    ],
    "objectTypeMismatch": true,
    "skipped": [
      "<string>"
    ]
  }
}