mautic.json•12.5 kB
{
"nodeType": "n8n-nodes-base.mautic",
"displayName": "Mautic",
"description": "Consume Mautic API",
"version": 1,
"properties": [
{
"name": "contactId",
"displayName": "Contact ID",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"resource": [
"campaignContact"
],
"operation": [
"add",
"remove"
]
}
}
},
{
"name": "campaignId",
"displayName": "Campaign Name or ID",
"type": "options",
"default": "",
"description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
"required": true,
"displayOptions": {
"show": {
"resource": [
"campaignContact"
],
"operation": [
"add",
"remove"
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "add",
"description": "Add contact to a campaign",
"options": [
{
"name": "Add",
"value": "add",
"description": "Add contact to a campaign"
},
{
"name": "Remove",
"value": "remove",
"description": "Remove contact from a campaign"
}
],
"displayOptions": {
"show": {
"resource": [
"campaignContact"
]
}
}
},
{
"name": "companyId",
"displayName": "Company ID",
"type": "string",
"default": "",
"description": "The ID of the company",
"displayOptions": {
"show": {
"resource": [
"companyContact"
],
"operation": [
"add",
"remove"
]
}
}
},
{
"name": "name",
"displayName": "Company Name",
"type": "string",
"default": "",
"description": "The name of the company to create",
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"create"
]
}
}
},
{
"name": "simple",
"displayName": "Simplify",
"type": "boolean",
"default": true,
"description": "Whether to return a simplified version of the response instead of the raw data",
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"create"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "Adds a custom fields to set also values which have not been predefined",
"placeholder": "Add Field",
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"create"
]
}
}
},
{
"name": "updateFields",
"displayName": "Update Fields",
"type": "collection",
"default": {},
"description": "Adds a custom fields to set also values which have not been predefined",
"placeholder": "Add Field",
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"update"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 30,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1,
"maxValue": 30
},
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"getAll"
],
"returnAll": [
false
]
}
}
},
{
"name": "jsonParameters",
"displayName": "JSON Parameters",
"type": "boolean",
"default": false,
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"contact"
]
}
}
},
{
"name": "email",
"displayName": "Email",
"type": "string",
"default": "",
"description": "Email address of the contact",
"placeholder": "name@email.com",
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "firstName",
"displayName": "First Name",
"type": "string",
"default": "",
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "lastName",
"displayName": "Last Name",
"type": "string",
"default": "",
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "company",
"displayName": "Primary Company Name or ID",
"type": "options",
"default": "",
"description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "position",
"displayName": "Position",
"type": "string",
"default": "",
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "title",
"displayName": "Title",
"type": "string",
"default": "",
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "bodyJson",
"displayName": "Body",
"type": "json",
"default": "",
"description": "Contact parameters",
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"contact"
],
"jsonParameters": [
true
]
}
}
},
{
"name": "action",
"displayName": "Action",
"type": "options",
"default": "add",
"options": [
{
"name": "Add",
"value": "add"
},
{
"name": "Remove",
"value": "remove"
}
],
"displayOptions": {
"show": {
"operation": [
"editDoNotContactList"
],
"resource": [
"contact"
]
}
}
},
{
"name": "channel",
"displayName": "Channel",
"type": "options",
"default": "email",
"required": true,
"options": [
{
"name": "Email",
"value": "email"
},
{
"name": "SMS",
"value": "sms"
}
],
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"editDoNotContactList"
]
}
}
},
{
"name": "points",
"displayName": "Points",
"type": "number",
"default": 0,
"displayOptions": {
"show": {
"operation": [
"editContactPoint"
],
"resource": [
"contact"
]
}
}
},
{
"name": "options",
"displayName": "Options",
"type": "collection",
"default": {},
"description": "String or search command to filter entities by",
"placeholder": "Add option",
"displayOptions": {
"show": {
"resource": [
"contact"
]
}
}
},
{
"name": "campaignEmailId",
"displayName": "Campaign Email Name or ID",
"type": "options",
"default": "",
"description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
"required": true,
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"sendEmail"
]
}
}
},
{
"name": "segmentId",
"displayName": "Segment Name or ID",
"type": "options",
"default": "",
"description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
"required": true,
"displayOptions": {
"show": {
"resource": [
"contactSegment"
],
"operation": [
"add",
"remove"
]
}
}
},
{
"name": "segmentEmailId",
"displayName": "Segment Email Name or ID",
"type": "options",
"default": "",
"description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
"required": true,
"displayOptions": {
"show": {
"resource": [
"segmentEmail"
],
"operation": [
"send"
]
}
}
},
{
"name": "authentication",
"displayName": "Authentication",
"type": "options",
"default": "credentials",
"options": [
{
"name": "Credentials",
"value": "credentials"
},
{
"name": "OAuth2",
"value": "oAuth2"
}
]
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "contact",
"description": "Add/remove contacts to/from a campaign",
"options": [
{
"name": "Campaign Contact",
"value": "campaignContact",
"description": "Add/remove contacts to/from a campaign"
},
{
"name": "Company",
"value": "company",
"description": "Create or modify a company"
},
{
"name": "Company Contact",
"value": "companyContact",
"description": "Add/remove contacts to/from a company"
},
{
"name": "Contact",
"value": "contact",
"description": "Create & modify contacts"
},
{
"name": "Contact Segment",
"value": "contactSegment",
"description": "Add/remove contacts to/from a segment"
},
{
"name": "Segment Email",
"value": "segmentEmail",
"description": "Send an email"
}
]
}
],
"credentialsConfig": [
{
"name": "mauticApi",
"required": true
},
{
"name": "authentication",
"required": false
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [],
"outputs": [],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [],
"produces": []
}
}