PlatformDocs
MCP server

set_crm_mappings

Sets the field mappings for contacts or companies pushed to a CRM.

View as Markdown

Set CRM field mappings · Deletes or overwrites data

Sets the field mappings for contacts or companies pushed to a CRM. The list you send replaces the current one; get_crm_mappings first and list_crm_variables for the fields.

ConnectionAccount URL, team member URL or OAuth

Parameters

ParameterTypeRequiredAcceptsDescription
websiteIdstringYesanyWebsite ID from list_websites.
crmstringYeshubspot, salesforce, pipedrive, zoho, gohighlevelThe CRM.
objectTypestringYescontact, companycontact or company.
mappingsobject[]YesanyThe full list for this CRM and object type; it replaces what is saved (an empty list clears it).
mappings[].crmFieldstringYesanyThe CRM field name (its API name, e.g. firstname in HubSpot).
mappings[].crmFieldLabelstringNoanyOptional label shown in the dashboard; defaults to crmField.
mappings[].valueTypestringNodefault "variable" · variable, staticvariable (fill from the lead, default) or static (the same text every time).
mappings[].variablestringNo40 valuesThe lead field when valueType is variable, from list_crm_variables.
mappings[].staticValuestringNoanyThe fixed text when valueType is static.
mappings[].enabledbooleanNodefault truefalse keeps the row but skips it (default true).

Accepted values

The exact values these fields take; anything else is refused.

mappings[].variable

lead.person.firstName · lead.person.lastName · lead.person.businessEmail · lead.person.personalEmail · lead.person.phone · lead.person.position · lead.person.linkedin · lead.person.department · lead.person.seniority · lead.company.name · lead.company.domain · lead.company.phone · lead.company.city · lead.company.state · lead.company.country · lead.company.countryCode · lead.company.industry · lead.company.sector · lead.company.employees · lead.company.employeesRange · lead.company.estimatedRevenue · lead.company.foundedYear · lead.company.linkedinPage · lead.company.description · lead.visit.pageCount · lead.visit.pageList · lead.visit.sessionCount · lead.visit.ipAddress · lead.visit.city · lead.visit.state · lead.visit.countryCode · lead.utm.source · lead.utm.medium · lead.utm.campaign · lead.utm.term · lead.utm.referrer · lead.score · lead.firstSeen · lead.lastSeen · lead.contactType

Tool definition

What your assistant receives from tools/list:

{
  "name": "set_crm_mappings",
  "title": "Set CRM field mappings",
  "annotations": {
    "title": "Set CRM field mappings",
    "readOnlyHint": false,
    "destructiveHint": true,
    "idempotentHint": true,
    "openWorldHint": false
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "websiteId": {
        "type": "string",
        "description": "Website ID from list_websites."
      },
      "crm": {
        "type": "string",
        "enum": [
          "hubspot",
          "salesforce",
          "pipedrive",
          "zoho",
          "gohighlevel"
        ],
        "description": "The CRM."
      },
      "objectType": {
        "type": "string",
        "enum": [
          "contact",
          "company"
        ],
        "description": "contact or company."
      },
      "mappings": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "crmField": {
              "type": "string",
              "description": "The CRM field name (its API name, e.g. firstname in HubSpot)."
            },
            "crmFieldLabel": {
              "type": "string",
              "description": "Optional label shown in the dashboard; defaults to crmField."
            },
            "valueType": {
              "type": "string",
              "enum": [
                "variable",
                "static"
              ],
              "default": "variable",
              "description": "variable (fill from the lead, default) or static (the same text every time)."
            },
            "variable": {
              "type": "string",
              "enum": [
                "lead.person.firstName",
                "lead.person.lastName",
                "lead.person.businessEmail",
                "lead.person.personalEmail",
                "lead.person.phone",
                "lead.person.position",
                "lead.person.linkedin",
                "lead.person.department",
                "lead.person.seniority",
                "lead.company.name",
                "lead.company.domain",
                "lead.company.phone",
                "lead.company.city",
                "lead.company.state",
                "lead.company.country",
                "lead.company.countryCode",
                "lead.company.industry",
                "lead.company.sector",
                "lead.company.employees",
                "lead.company.employeesRange",
                "lead.company.estimatedRevenue",
                "lead.company.foundedYear",
                "lead.company.linkedinPage",
                "lead.company.description",
                "lead.visit.pageCount",
                "lead.visit.pageList",
                "lead.visit.sessionCount",
                "lead.visit.ipAddress",
                "lead.visit.city",
                "lead.visit.state",
                "lead.visit.countryCode",
                "lead.utm.source",
                "lead.utm.medium",
                "lead.utm.campaign",
                "lead.utm.term",
                "lead.utm.referrer",
                "lead.score",
                "lead.firstSeen",
                "lead.lastSeen",
                "lead.contactType"
              ],
              "description": "The lead field when valueType is variable, from list_crm_variables."
            },
            "staticValue": {
              "type": "string",
              "description": "The fixed text when valueType is static."
            },
            "enabled": {
              "type": "boolean",
              "default": true,
              "description": "false keeps the row but skips it (default true)."
            }
          },
          "required": [
            "crmField"
          ]
        },
        "description": "The full list for this CRM and object type; it replaces what is saved (an empty list clears it)."
      }
    },
    "required": [
      "websiteId",
      "crm",
      "objectType",
      "mappings"
    ]
  }
}

On this page