set_crm_mappings
Sets the field mappings for contacts or companies pushed to a CRM.
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.
| Connection | Account URL, team member URL or OAuth |
|---|
Parameters
| Parameter | Type | Required | Accepts | Description |
|---|---|---|---|---|
websiteId | string | Yes | any | Website ID from list_websites. |
crm | string | Yes | hubspot, salesforce, pipedrive, zoho, gohighlevel | The CRM. |
objectType | string | Yes | contact, company | contact or company. |
mappings | object[] | Yes | any | The full list for this CRM and object type; it replaces what is saved (an empty list clears it). |
mappings[].crmField | string | Yes | any | The CRM field name (its API name, e.g. firstname in HubSpot). |
mappings[].crmFieldLabel | string | No | any | Optional label shown in the dashboard; defaults to crmField. |
mappings[].valueType | string | No | default "variable" · variable, static | variable (fill from the lead, default) or static (the same text every time). |
mappings[].variable | string | No | 40 values | The lead field when valueType is variable, from list_crm_variables. |
mappings[].staticValue | string | No | any | The fixed text when valueType is static. |
mappings[].enabled | boolean | No | default true | false 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"
]
}
}get_crm_mappings
The field mappings used when leads are pushed to a CRM: which lead field fills which CRM field, for contacts and companies.
get_slack_message_template
The template of the message posted to Slack for each lead: template (null = the default is used), defaultTemplate and mergeFields (every field a template may use).