# nodes

node_type: nodes-base.mailchimpTrigger
package_name: n8n-nodes-base
display_name: Mailchimp Trigger
description: Handle Mailchimp events via webhooks
category: trigger
development_style: programmatic
version: 1
operations: []
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mailchimp Trigger node documentation
  description: Learn how to use the Mailchimp Trigger node in n8n. Follow technical documentation to integrate Mailchimp Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Mailchimp Trigger node

  [Mailchimp](https://mailchimp.com/){:target=_blank .external-link} is an integrated marketing platform that allows business owners to automate their email campaigns and track user engagement.

  /// note | Credentials
  You can find authentication information for this node [here](/integrations/builtin/credentials/mailchimp.md).
  ///

  ///  note  | Examples and templates
  For usage examples and templates to help you get started, refer to n8n's [Mailchimp Trigger integrations](https://n8n.io/integrations/mailchimp-trigger/){:target=_blank .external-link} page.
  ///

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "apiKey",
      "options": [
        {
          "name": "API Key",
          "value": "apiKey"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "List Name or ID",
      "name": "list",
      "type": "options",
      "default": "",
      "description": "The list that is gonna fire the event. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Events",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "description": "The events that can trigger the webhook and whether they are enabled",
      "options": [
        {
          "name": "Campaign Sent",
          "value": "campaign",
          "description": "Whether the webhook is triggered when a campaign is sent or cancelled"
        },
        {
          "name": "Cleaned",
          "value": "cleaned",
          "description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list"
        },
        {
          "name": "Email Address Updated",
          "value": "upemail",
          "description": "Whether the webhook is triggered when a subscriber's email address is changed"
        },
        {
          "name": "Profile Updated",
          "value": "profile",
          "description": "Whether the webhook is triggered when a subscriber's profile is updated"
        },
        {
          "name": "Subscribe",
          "value": "subscribe",
          "description": "Whether the webhook is triggered when a list subscriber is added"
        },
        {
          "name": "Unsubscribe",
          "value": "unsubscribe",
          "description": "Whether the webhook is triggered when a list member unsubscribes"
        }
      ],
      "required": true
    },
    {
      "displayName": "Sources",
      "name": "sources",
      "type": "multiOptions",
      "default": [],
      "description": "The possible sources of any events that can trigger the webhook and whether they are enabled",
      "options": [
        {
          "name": "User",
          "value": "user",
          "description": "Whether the webhook is triggered by subscriber-initiated actions"
        },
        {
          "name": "Admin",
          "value": "admin",
          "description": "Whether the webhook is triggered by admin-initiated actions in the web interface"
        },
        {
          "name": "API",
          "value": "api",
          "description": "Whether the webhook is triggered by actions initiated via the API"
        }
      ],
      "required": true
    }
  ]

credentials_required:
  [
    {
      "name": "mailchimpApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "apiKey"
          ]
        }
      }
    },
    {
      "name": "mailchimpOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


node_type: nodes-base.mailerLiteTool
package_name: n8n-nodes-base
display_name: MailerLite Tool
description: Consume MailerLite API (AI Tool variant for use with AI Agents)
category: input
development_style: programmatic
version: 2
credentials_required:
  [
  {
  "name": "mailerLiteApi",
  "required": true
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.mailerLite
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: MailerLite node documentation
  description: Learn how to use the MailerLite node in n8n. Follow technical documentation to integrate MailerLite node into your workflows.
  contentType: [integration, reference]
  ---

  # MailerLite node

  Use the MailerLite node to automate work in MailerLite, and integrate MailerLite with other applications. n8n has built-in support for a wide range of MailerLite features, including creating, updating, deleting, and getting subscribers.

  On this page, you'll find a list of operations the MailerLite node supports and links to more resources.

  /// note | Credentials
  Refer to [MailerLite credentials](/integrations/builtin/credentials/mailerlite.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Subscriber
      * Create a new subscriber
      * Get an subscriber
      * Get all subscribers
      * Update an subscriber

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mailerlite') ]]

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to send and manage emails"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "subscriber",
      "options": [
        {
          "name": "Subscriber",
          "value": "subscriber"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new subscriber",
          "action": "Create a subscriber"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an subscriber",
          "action": "Get a subscriber"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many subscribers",
          "action": "Get many subscribers"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an subscriber",
          "action": "Update a subscriber"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email of new subscriber",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Subscriber Email",
      "name": "subscriberId",
      "type": "string",
      "default": "",
      "description": "Email of subscriber",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Field",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "description": "Filter by custom fields",
          "default": {},
          "options": [
            {
              "name": "customFieldsValues",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "default": "",
                  "description": "The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The value to set on custom field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Bounced",
              "value": "bounced"
            },
            {
              "name": "Junk",
              "value": "junk"
            },
            {
              "name": "Unconfirmed",
              "value": "unconfirmed"
            },
            {
              "name": "Unsubscribed",
              "value": "unsubscribed"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Subscribed At",
          "name": "subscribed_at",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "IP Address",
          "name": "ip_address",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Opted In At",
          "name": "opted_in_at",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Opt In IP",
          "name": "optin_ip",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Unsubscribed At",
          "name": "unsubscribed_at",
          "type": "dateTime",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "update",
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Subscriber Email",
      "name": "subscriberId",
      "type": "string",
      "default": "",
      "description": "Email of subscriber to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Subscriber Email",
      "name": "subscriberId",
      "type": "string",
      "default": "",
      "description": "Email of subscriber to get",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Bounced",
              "value": "bounced"
            },
            {
              "name": "Junk",
              "value": "junk"
            },
            {
              "name": "Unconfirmed",
              "value": "unconfirmed"
            },
            {
              "name": "Unsubscribed",
              "value": "unsubscribed"
            }
          ],
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "subscriber"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new subscriber",
      "resource": "subscriber"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an subscriber",
      "resource": "subscriber"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many subscribers",
      "resource": "subscriber"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an subscriber",
      "resource": "subscriber"
    }
  ]


node_type: nodes-base.mailerLite
package_name: n8n-nodes-base
display_name: MailerLite
description: Consume MailerLite API
category: input
development_style: programmatic
version: 2
credentials_required:
  [
  {
  "name": "mailerLiteApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: MailerLite node documentation
  description: Learn how to use the MailerLite node in n8n. Follow technical documentation to integrate MailerLite node into your workflows.
  contentType: [integration, reference]
  ---

  # MailerLite node

  Use the MailerLite node to automate work in MailerLite, and integrate MailerLite with other applications. n8n has built-in support for a wide range of MailerLite features, including creating, updating, deleting, and getting subscribers.

  On this page, you'll find a list of operations the MailerLite node supports and links to more resources.

  /// note | Credentials
  Refer to [MailerLite credentials](/integrations/builtin/credentials/mailerlite.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Subscriber
      * Create a new subscriber
      * Get an subscriber
      * Get all subscribers
      * Update an subscriber

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mailerlite') ]]

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "subscriber",
      "options": [
        {
          "name": "Subscriber",
          "value": "subscriber"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new subscriber",
          "action": "Create a subscriber"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an subscriber",
          "action": "Get a subscriber"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many subscribers",
          "action": "Get many subscribers"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an subscriber",
          "action": "Update a subscriber"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email of new subscriber",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Subscriber Email",
      "name": "subscriberId",
      "type": "string",
      "default": "",
      "description": "Email of subscriber",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Field",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "description": "Filter by custom fields",
          "default": {},
          "options": [
            {
              "name": "customFieldsValues",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "default": "",
                  "description": "The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The value to set on custom field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Bounced",
              "value": "bounced"
            },
            {
              "name": "Junk",
              "value": "junk"
            },
            {
              "name": "Unconfirmed",
              "value": "unconfirmed"
            },
            {
              "name": "Unsubscribed",
              "value": "unsubscribed"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Subscribed At",
          "name": "subscribed_at",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "IP Address",
          "name": "ip_address",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Opted In At",
          "name": "opted_in_at",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Opt In IP",
          "name": "optin_ip",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Unsubscribed At",
          "name": "unsubscribed_at",
          "type": "dateTime",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "update",
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Subscriber Email",
      "name": "subscriberId",
      "type": "string",
      "default": "",
      "description": "Email of subscriber to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Subscriber Email",
      "name": "subscriberId",
      "type": "string",
      "default": "",
      "description": "Email of subscriber to get",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "subscriber"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Bounced",
              "value": "bounced"
            },
            {
              "name": "Junk",
              "value": "junk"
            },
            {
              "name": "Unconfirmed",
              "value": "unconfirmed"
            },
            {
              "name": "Unsubscribed",
              "value": "unsubscribed"
            }
          ],
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "subscriber"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new subscriber",
      "resource": "subscriber"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an subscriber",
      "resource": "subscriber"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many subscribers",
      "resource": "subscriber"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an subscriber",
      "resource": "subscriber"
    }
  ]


node_type: nodes-base.mailerLiteTrigger
package_name: n8n-nodes-base
display_name: MailerLite Trigger
description: Starts the workflow when MailerLite events occur
category: trigger
development_style: programmatic
version: 2
operations: []
credentials_required:
  [
  {
  "name": "mailerLiteApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: MailerLite Trigger node documentation
  description: Learn how to use the MailerLite Trigger node in n8n. Follow technical documentation to integrate MailerLite Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # MailerLite Trigger node

  [MailerLite](https://www.mailerlite.com/){:target=_blank .external-link} is an email marketing solution that provides you with a user-friendly content editor, simplified subscriber management, and campaign reports with the most important statistics.

  On this page, you'll find a list of events the MailerLite Trigger node can respond to and links to more resources.

  /// note | Credentials
  You can find authentication information for this node [here](/integrations/builtin/credentials/mailerlite.md).
  ///

  ///  note  | Examples and templates
  For usage examples and templates to help you get started, refer to n8n's [MailerLite Trigger integrations](https://n8n.io/integrations/mailerlite-trigger/){:target=_blank .external-link} page.
  ///

  ## Events

  - Campaign Sent
  - Subscriber Added to Group
  - Subscriber Automation Completed
  - Subscriber Automation Triggered
  - Subscriber Bounced
  - Subscriber Created
  - Subscriber Complained
  - Subscriber Removed from Group
  - Subscriber Unsubscribe
  - Subscriber Updated

properties_schema:
  [
    {
      "displayName": "Events",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "description": "The events to listen to",
      "options": [
        {
          "name": "Campaign Sent",
          "value": "campaign.sent",
          "description": "Fired when campaign is sent"
        },
        {
          "name": "Subscriber Added to Group",
          "value": "subscriber.added_to_group",
          "description": "Fired when a subscriber is added to a group"
        },
        {
          "name": "Subscriber Automation Completed",
          "value": "subscriber.automation_completed",
          "description": "Fired when subscriber finishes automation"
        },
        {
          "name": "Subscriber Automation Triggered",
          "value": "subscriber.automation_triggered",
          "description": "Fired when subscriber starts automation"
        },
        {
          "name": "Subscriber Bounced",
          "value": "subscriber.bounced",
          "description": "Fired when an email address bounces"
        },
        {
          "name": "Subscriber Created",
          "value": "subscriber.created",
          "description": "Fired when a new subscriber is added to an account"
        },
        {
          "name": "Subscriber Removed From Group",
          "value": "subscriber.removed_from_group",
          "description": "Fired when a subscriber is removed from a group"
        },
        {
          "name": "Subscriber Spam Reported",
          "value": "subscriber.spam_reported",
          "description": "Fired when subscriber marks a campaign as a spam"
        },
        {
          "name": "Subscriber Unsubscribe",
          "value": "subscriber.unsubscribed",
          "description": "Fired when a subscriber becomes unsubscribed"
        },
        {
          "name": "Subscriber Updated",
          "value": "subscriber.updated",
          "description": "Fired when any of the subscriber's custom fields are updated"
        }
      ],
      "required": true
    }
  ]


node_type: nodes-base.mailgunTool
package_name: n8n-nodes-base
display_name: Mailgun Tool
description: Sends an email via Mailgun (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "mailgunApi",
  "required": true
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.mailgun
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mailgun node documentation
  description: Learn how to use the Mailgun node in n8n. Follow technical documentation to integrate Mailgun node into your workflows.
  contentType: [integration, reference]
  ---

  # Mailgun node

  Use the Mailgun node to automate work in Mailgun, and integrate Mailgun with other applications. n8n has built-in support for sending emails with Mailgun. 

  On this page, you'll find a list of operations the Mailgun node supports and links to more resources.

  /// note | Credentials
  Refer to [Mailgun credentials](/integrations/builtin/credentials/mailgun.md) for guidance on setting up authentication. 
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  - Send an email

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mailgun') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to send and manage emails"
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender optional with name",
      "required": true
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. Multiple ones can be separated by comma.",
      "required": true
    },
    {
      "displayName": "Cc Email",
      "name": "ccEmail",
      "type": "string",
      "default": "",
      "description": "Cc Email address of the recipient. Multiple ones can be separated by comma."
    },
    {
      "displayName": "Bcc Email",
      "name": "bccEmail",
      "type": "string",
      "default": "",
      "description": "Bcc Email address of the recipient. Multiple ones can be separated by comma."
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Subject line of the email"
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Plain text message of email",
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "HTML",
      "name": "html",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "typeOptions": {
        "rows": 5,
        "editor": "htmlEditor"
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachments",
      "type": "string",
      "default": "",
      "description": "Name of the binary properties which contain data which should be added to email as attachment. Multiple ones can be comma-separated."
    }
  ]


node_type: nodes-base.mailgun
package_name: n8n-nodes-base
display_name: Mailgun
description: Sends an email via Mailgun
category: output
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "mailgunApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mailgun node documentation
  description: Learn how to use the Mailgun node in n8n. Follow technical documentation to integrate Mailgun node into your workflows.
  contentType: [integration, reference]
  ---

  # Mailgun node

  Use the Mailgun node to automate work in Mailgun, and integrate Mailgun with other applications. n8n has built-in support for sending emails with Mailgun. 

  On this page, you'll find a list of operations the Mailgun node supports and links to more resources.

  /// note | Credentials
  Refer to [Mailgun credentials](/integrations/builtin/credentials/mailgun.md) for guidance on setting up authentication. 
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  - Send an email

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mailgun') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender optional with name",
      "required": true
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. Multiple ones can be separated by comma.",
      "required": true
    },
    {
      "displayName": "Cc Email",
      "name": "ccEmail",
      "type": "string",
      "default": "",
      "description": "Cc Email address of the recipient. Multiple ones can be separated by comma."
    },
    {
      "displayName": "Bcc Email",
      "name": "bccEmail",
      "type": "string",
      "default": "",
      "description": "Bcc Email address of the recipient. Multiple ones can be separated by comma."
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Subject line of the email"
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Plain text message of email",
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "HTML",
      "name": "html",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "typeOptions": {
        "rows": 5,
        "editor": "htmlEditor"
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachments",
      "type": "string",
      "default": "",
      "description": "Name of the binary properties which contain data which should be added to email as attachment. Multiple ones can be comma-separated."
    }
  ]


node_type: nodes-base.mailjetTool
package_name: n8n-nodes-base
display_name: Mailjet Tool
description: Consume Mailjet API (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 1
outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.mailjet
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mailjet node documentation
  description: Learn how to use the Mailjet node in n8n. Follow technical documentation to integrate Mailjet node into your workflows.
  contentType: [integration, reference]
  ---

  # Mailjet node

  Use the Mailjet node to automate work in Mailjet, and integrate Mailjet with other applications. n8n has built-in support for a wide range of Mailjet features, including sending emails, and SMS. 

  On this page, you'll find a list of operations the Mailjet node supports and links to more resources.

  /// note | Credentials
  Refer to [Mailjet credentials](/integrations/builtin/credentials/mailjet.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Email
      * Send an email
      * Send an email template
  * SMS
      * Send an SMS

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mailjet') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to send and manage emails"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "email",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "SMS",
          "value": "sms"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Send a email",
          "action": "Send an email"
        },
        {
          "name": "Send Template",
          "value": "sendTemplate",
          "description": "Send a email template",
          "action": "Send an email template"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "The title for the email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. Multiple ones can be separated by comma.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Subject line of the email"
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Plain text message of email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "HTML",
      "name": "html",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bcc Email",
          "name": "bccEmail",
          "type": "string",
          "description": "Bcc Email address of the recipient. Multiple ones can be separated by comma.",
          "default": ""
        },
        {
          "displayName": "Cc Addresses",
          "name": "ccAddresses",
          "type": "string",
          "description": "Cc Email address of the recipient. Multiple ones can be separated by comma.",
          "default": ""
        },
        {
          "displayName": "From Name",
          "name": "fromName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "number",
          "default": 2
        },
        {
          "displayName": "Reply To",
          "name": "replyTo",
          "type": "string",
          "description": "The reply-to email address. Multiple ones can be separated by comma.",
          "default": ""
        },
        {
          "displayName": "Template Language",
          "name": "templateLanguage",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Track Clicks",
          "name": "trackClicks",
          "type": "options",
          "options": [
            {
              "name": "Account Default",
              "value": "account_default",
              "description": "Use the values specified in the Mailjet account"
            },
            {
              "name": "Disabled",
              "value": "disabled",
              "description": "Disable tracking for this message"
            },
            {
              "name": "Enabled",
              "value": "enabled",
              "description": "Enable tracking for this message"
            }
          ],
          "description": "Enable or disable open tracking on this message",
          "default": "account_default"
        },
        {
          "displayName": "Track Opens",
          "name": "trackOpens",
          "type": "options",
          "options": [
            {
              "name": "Account Default",
              "value": "account_default",
              "description": "Use the values specified in the Mailjet account"
            },
            {
              "name": "Disabled",
              "value": "disabled",
              "description": "Disable tracking for this message"
            },
            {
              "name": "Enabled",
              "value": "enabled",
              "description": "Enable tracking for this message"
            }
          ],
          "description": "Enable or disable open tracking on this message",
          "default": "account_default"
        },
        {
          "displayName": "Custom Campaign",
          "name": "customCampaign",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Deduplicate Campaign",
          "name": "deduplicateCampaign",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Variables (JSON)",
      "name": "variablesJson",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ],
          "jsonParameters": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Variables",
      "name": "variablesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "variablesValues",
          "displayName": "Variable",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "The title for the email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. Multiple ones can be separated by comma.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Template Name or ID",
      "name": "templateId",
      "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": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTemplates"
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bcc Email",
          "name": "bccEmail",
          "type": "string",
          "description": "BCC Recipients of the email separated by ,",
          "default": ""
        },
        {
          "displayName": "Cc Email",
          "name": "ccEmail",
          "type": "string",
          "description": "Cc recipients of the email separated by ,",
          "default": ""
        },
        {
          "displayName": "From Name",
          "name": "fromName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "number",
          "default": 2
        },
        {
          "displayName": "Reply To",
          "name": "replyTo",
          "type": "string",
          "description": "The reply-to email address. Multiple ones can be separated by comma.",
          "default": ""
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Template Language",
          "name": "templateLanguage",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Track Clicks",
          "name": "trackClicks",
          "type": "string",
          "description": "Enable or disable open tracking on this message",
          "default": ""
        },
        {
          "displayName": "Track Opens",
          "name": "trackOpens",
          "type": "string",
          "description": "Enable or disable open tracking on this message",
          "default": ""
        },
        {
          "displayName": "Custom Campaign",
          "name": "customCampaign",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Deduplicate Campaign",
          "name": "deduplicateCampaign",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Variables",
      "name": "variablesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "variablesValues",
          "displayName": "Variable",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Variables (JSON)",
      "name": "variablesJson",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ],
          "jsonParameters": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Send a sms",
          "action": "Send an SMS"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "From",
      "name": "from",
      "type": "string",
      "default": "",
      "description": "Customizable sender name. Should be between 3 and 11 characters in length, only alphanumeric characters are allowed.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "To",
      "name": "to",
      "type": "string",
      "default": "",
      "description": "Message recipient. Should be between 3 and 15 characters in length. The number always starts with a plus sign followed by a country code, followed by the number. Phone numbers are expected to comply with the E.164 format.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ],
          "operation": [
            "send"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "send",
      "name": "Send",
      "description": "Send a email",
      "resource": "email"
    },
    {
      "operation": "sendTemplate",
      "name": "Send Template",
      "description": "Send a email template",
      "resource": "email"
    },
    {
      "operation": "send",
      "name": "Send",
      "description": "Send a sms",
      "resource": "sms"
    }
  ]

credentials_required:
  [
    {
      "name": "mailjetEmailApi",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ]
        }
      }
    },
    {
      "name": "mailjetSmsApi",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ]
        }
      }
    }
  ]


node_type: nodes-base.mailjet
package_name: n8n-nodes-base
display_name: Mailjet
description: Consume Mailjet API
category: output
development_style: programmatic
version: 1
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mailjet node documentation
  description: Learn how to use the Mailjet node in n8n. Follow technical documentation to integrate Mailjet node into your workflows.
  contentType: [integration, reference]
  ---

  # Mailjet node

  Use the Mailjet node to automate work in Mailjet, and integrate Mailjet with other applications. n8n has built-in support for a wide range of Mailjet features, including sending emails, and SMS. 

  On this page, you'll find a list of operations the Mailjet node supports and links to more resources.

  /// note | Credentials
  Refer to [Mailjet credentials](/integrations/builtin/credentials/mailjet.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Email
      * Send an email
      * Send an email template
  * SMS
      * Send an SMS

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mailjet') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "email",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "SMS",
          "value": "sms"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Send a email",
          "action": "Send an email"
        },
        {
          "name": "Send Template",
          "value": "sendTemplate",
          "description": "Send a email template",
          "action": "Send an email template"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "The title for the email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. Multiple ones can be separated by comma.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Subject line of the email"
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Plain text message of email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "HTML",
      "name": "html",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bcc Email",
          "name": "bccEmail",
          "type": "string",
          "description": "Bcc Email address of the recipient. Multiple ones can be separated by comma.",
          "default": ""
        },
        {
          "displayName": "Cc Addresses",
          "name": "ccAddresses",
          "type": "string",
          "description": "Cc Email address of the recipient. Multiple ones can be separated by comma.",
          "default": ""
        },
        {
          "displayName": "From Name",
          "name": "fromName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "number",
          "default": 2
        },
        {
          "displayName": "Reply To",
          "name": "replyTo",
          "type": "string",
          "description": "The reply-to email address. Multiple ones can be separated by comma.",
          "default": ""
        },
        {
          "displayName": "Template Language",
          "name": "templateLanguage",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Track Clicks",
          "name": "trackClicks",
          "type": "options",
          "options": [
            {
              "name": "Account Default",
              "value": "account_default",
              "description": "Use the values specified in the Mailjet account"
            },
            {
              "name": "Disabled",
              "value": "disabled",
              "description": "Disable tracking for this message"
            },
            {
              "name": "Enabled",
              "value": "enabled",
              "description": "Enable tracking for this message"
            }
          ],
          "description": "Enable or disable open tracking on this message",
          "default": "account_default"
        },
        {
          "displayName": "Track Opens",
          "name": "trackOpens",
          "type": "options",
          "options": [
            {
              "name": "Account Default",
              "value": "account_default",
              "description": "Use the values specified in the Mailjet account"
            },
            {
              "name": "Disabled",
              "value": "disabled",
              "description": "Disable tracking for this message"
            },
            {
              "name": "Enabled",
              "value": "enabled",
              "description": "Enable tracking for this message"
            }
          ],
          "description": "Enable or disable open tracking on this message",
          "default": "account_default"
        },
        {
          "displayName": "Custom Campaign",
          "name": "customCampaign",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Deduplicate Campaign",
          "name": "deduplicateCampaign",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Variables (JSON)",
      "name": "variablesJson",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ],
          "jsonParameters": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Variables",
      "name": "variablesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "variablesValues",
          "displayName": "Variable",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "send"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "The title for the email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. Multiple ones can be separated by comma.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Template Name or ID",
      "name": "templateId",
      "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": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTemplates"
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bcc Email",
          "name": "bccEmail",
          "type": "string",
          "description": "BCC Recipients of the email separated by ,",
          "default": ""
        },
        {
          "displayName": "Cc Email",
          "name": "ccEmail",
          "type": "string",
          "description": "Cc recipients of the email separated by ,",
          "default": ""
        },
        {
          "displayName": "From Name",
          "name": "fromName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "number",
          "default": 2
        },
        {
          "displayName": "Reply To",
          "name": "replyTo",
          "type": "string",
          "description": "The reply-to email address. Multiple ones can be separated by comma.",
          "default": ""
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Template Language",
          "name": "templateLanguage",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Track Clicks",
          "name": "trackClicks",
          "type": "string",
          "description": "Enable or disable open tracking on this message",
          "default": ""
        },
        {
          "displayName": "Track Opens",
          "name": "trackOpens",
          "type": "string",
          "description": "Enable or disable open tracking on this message",
          "default": ""
        },
        {
          "displayName": "Custom Campaign",
          "name": "customCampaign",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Deduplicate Campaign",
          "name": "deduplicateCampaign",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Variables",
      "name": "variablesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "variablesValues",
          "displayName": "Variable",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Variables (JSON)",
      "name": "variablesJson",
      "type": "string",
      "default": "",
      "description": "HTML text message of email",
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ],
          "operation": [
            "sendTemplate"
          ],
          "jsonParameters": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Send a sms",
          "action": "Send an SMS"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "From",
      "name": "from",
      "type": "string",
      "default": "",
      "description": "Customizable sender name. Should be between 3 and 11 characters in length, only alphanumeric characters are allowed.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "To",
      "name": "to",
      "type": "string",
      "default": "",
      "description": "Message recipient. Should be between 3 and 15 characters in length. The number always starts with a plus sign followed by a country code, followed by the number. Phone numbers are expected to comply with the E.164 format.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ],
          "operation": [
            "send"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "send",
      "name": "Send",
      "description": "Send a email",
      "resource": "email"
    },
    {
      "operation": "sendTemplate",
      "name": "Send Template",
      "description": "Send a email template",
      "resource": "email"
    },
    {
      "operation": "send",
      "name": "Send",
      "description": "Send a sms",
      "resource": "sms"
    }
  ]

credentials_required:
  [
    {
      "name": "mailjetEmailApi",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "email"
          ]
        }
      }
    },
    {
      "name": "mailjetSmsApi",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sms"
          ]
        }
      }
    }
  ]


node_type: nodes-base.mailjetTrigger
package_name: n8n-nodes-base
display_name: Mailjet Trigger
description: Handle Mailjet events via webhooks
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "mailjetEmailApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mailjet Trigger node documentation
  description: Learn how to use the Mailjet Trigger node in n8n. Follow technical documentation to integrate Mailjet Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Mailjet Trigger node

  [Mailjet](https://www.mailjet.com/){:target=_blank .external-link} is a cloud-based email sending and tracking system. The platform allows professionals to send both marketing emails and transactional emails. It includes tools for designing emails, sending massive volumes and tracking these messages.

  /// note | Credentials
  You can find authentication information for this node [here](/integrations/builtin/credentials/mailjet.md).
  ///

  ///  note  | Examples and templates
  For usage examples and templates to help you get started, refer to n8n's [Mailjet Trigger integrations](https://n8n.io/integrations/mailjet-trigger/){:target=_blank .external-link} page.
  ///

properties_schema:
  [
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "open",
      "description": "Determines which resource events the webhook is triggered for",
      "options": [
        {
          "name": "email.blocked",
          "value": "blocked"
        },
        {
          "name": "email.bounce",
          "value": "bounce"
        },
        {
          "name": "email.open",
          "value": "open"
        },
        {
          "name": "email.sent",
          "value": "sent"
        },
        {
          "name": "email.spam",
          "value": "spam"
        },
        {
          "name": "email.unsub",
          "value": "unsub"
        }
      ],
      "required": true
    }
  ]


node_type: nodes-base.mandrillTool
package_name: n8n-nodes-base
display_name: Mandrill Tool
description: Consume Mandrill API (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "mandrillApi",
  "required": true
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.mandrill
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mandrill node documentation
  description: Learn how to use the Mandrill node in n8n. Follow technical documentation to integrate Mandrill node into your workflows.
  contentType: [integration, reference]
  ---

  # Mandrill node

  Use the Mandrill node to automate work in Mandrill, and integrate Mandrill with other applications. n8n supports sending messages based on templates or HTML with Mandrill.

  On this page, you'll find a list of operations the Mandrill node supports and links to more resources.

  /// note | Credentials
  Refer to [Mandrill credentials](/integrations/builtin/credentials/mandrill.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Message
      * Send message based on template.
      * Send message based on HTML.

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mandrill') ]]

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Mandrill"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "message",
      "options": [
        {
          "name": "Message",
          "value": "message",
          "description": "Send a message"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "sendTemplate",
      "options": [
        {
          "name": "Send Template",
          "value": "sendTemplate",
          "description": "Send message based on template",
          "action": "Send a message based on a template"
        },
        {
          "name": "Send HTML",
          "value": "sendHtml",
          "description": "Send message based on HTML",
          "action": "Send a message based on HTML"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Template Name or ID",
      "name": "template",
      "type": "options",
      "default": "",
      "description": "The template you want to send. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "sendTemplate"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTemplates"
      }
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender optional with name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "sendHtml",
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. Multiple ones can be separated by comma.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "sendHtml",
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "sendHtml",
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Async",
          "name": "async",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of \"queued\" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async."
        },
        {
          "displayName": "Auto Text",
          "name": "autoText",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to automatically generate a text part for messages that are not given text"
        },
        {
          "displayName": "Auto HTML",
          "name": "autoHtml",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to automatically generate an HTML part for messages that are not given HTML"
        },
        {
          "displayName": "BCC Address",
          "name": "bccAddress",
          "type": "string",
          "default": "",
          "placeholder": "message.bcc_address@example.com",
          "description": "An optional address to receive an exact copy of each recipient's email"
        },
        {
          "displayName": "From Name",
          "name": "fromName",
          "type": "string",
          "default": "",
          "placeholder": "John Doe",
          "description": "Optional from name to be used"
        },
        {
          "displayName": "Google Analytics Campaign",
          "name": "googleAnalyticsCampaign",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "Optional string indicating the value to set for the utm_campaign tracking parameter. If this isn't provided the email's from address will be used instead."
        },
        {
          "displayName": "Google Analytics Domains",
          "name": "googleAnalyticsDomains",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "An array of strings separated by a comma (,) indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically"
        },
        {
          "displayName": "HTML",
          "name": "html",
          "type": "string",
          "default": "",
          "typeOptions": {
            "rows": 5
          },
          "options": [],
          "description": "The html you want to send"
        },
        {
          "displayName": "Important",
          "name": "important",
          "type": "boolean",
          "default": false,
          "description": "Whether or not this message is important, and should be delivered ahead of non-important messages"
        },
        {
          "displayName": "Inline CSS",
          "name": "inlineCss",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size"
        },
        {
          "displayName": "Ip Pool",
          "name": "ipPool",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "The name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead."
        },
        {
          "displayName": "Preserve Recipients",
          "name": "preserveRecipients",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to expose all recipients in to \"To\" header for each email"
        },
        {
          "displayName": "Return Path Domain",
          "name": "returnPathDomain",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "A custom domain to use for the messages's return-path"
        },
        {
          "displayName": "Sent At",
          "name": "sendAt",
          "type": "dateTime",
          "default": "",
          "placeholder": "",
          "description": "When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance."
        },
        {
          "displayName": "Signing Domain",
          "name": "signingDomain",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "A custom domain to use for SPF/DKIM signing instead of mandrill(for \"via\" or \"on behalf of\" in email clients)"
        },
        {
          "displayName": "Subaccount",
          "name": "subAccount",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "The unique ID of a subaccount for this message - must already exist or will fail with an error"
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": "",
          "placeholder": "My subject line",
          "description": "Subject line of the email"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "An array of string separated by a comma (,) to tag the message with. Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors."
        },
        {
          "displayName": "Text",
          "name": "text",
          "type": "string",
          "default": "",
          "typeOptions": {
            "rows": 5
          },
          "options": [],
          "description": "Example text content"
        },
        {
          "displayName": "Track Clicks",
          "name": "trackClicks",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to turn on click tracking for the message"
        },
        {
          "displayName": "Track Opens",
          "name": "trackOpens",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to turn on open tracking for the message"
        },
        {
          "displayName": "Tracking Domain",
          "name": "trackingDomain",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "A custom domain to use for tracking opens and clicks instead of mandrillapp.com"
        },
        {
          "displayName": "Url Strip Qs",
          "name": "urlStripQs",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to strip the query string from URLs when aggregating tracked URL data"
        },
        {
          "displayName": "View Content Link",
          "name": "viewContentLink",
          "type": "boolean",
          "default": false,
          "description": "Whether to remove content logging for sensitive emails"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "sendHtml",
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Merge Vars",
      "name": "mergeVarsJson",
      "type": "json",
      "default": "",
      "description": "Global merge variables",
      "displayOptions": {
        "show": {
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Merge Vars",
      "name": "mergeVarsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Per-recipient merge variables",
      "options": [
        {
          "name": "mergeVarsValues",
          "displayName": "Vars",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Content",
              "name": "content",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadataUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval. In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.",
      "options": [
        {
          "name": "metadataValues",
          "displayName": "Metadata",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "Name of the metadata key to add."
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value to set for the metadata key"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadataJson",
      "type": "json",
      "default": "",
      "description": "Metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval. In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.",
      "displayOptions": {
        "show": {
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachmentsJson",
      "type": "json",
      "default": "",
      "description": "An array of supported attachments to add to the message",
      "displayOptions": {
        "show": {
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachmentsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Array of supported attachments to add to the message",
      "options": [
        {
          "name": "attachmentsValues",
          "displayName": "Attachments Values",
          "values": [
            {
              "displayName": "Type",
              "name": "type",
              "type": "string",
              "default": "",
              "placeholder": "text/plain",
              "description": "The MIME type of the attachment"
            },
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "placeholder": "myfile.txt",
              "description": "The file name of the attachment"
            },
            {
              "displayName": "Content",
              "name": "content",
              "type": "string",
              "default": "",
              "placeholder": "ZXhhbXBsZSBmaWxl",
              "description": "The content of the attachment as a base64-encoded string"
            }
          ]
        },
        {
          "name": "attachmentsBinary",
          "displayName": "Attachments Binary",
          "values": [
            {
              "displayName": "Property",
              "name": "property",
              "type": "string",
              "default": "",
              "description": "Name of the binary properties which contain data which should be added to email as attachment"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Headers",
      "name": "headersJson",
      "type": "json",
      "default": "",
      "description": "Optional extra headers to add to the message (most headers are allowed)",
      "displayOptions": {
        "show": {
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Headers",
      "name": "headersUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Optional extra headers to add to the message (most headers are allowed)",
      "options": [
        {
          "name": "headersValues",
          "displayName": "Values",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    }
  ]

operations:
  [
    {
      "operation": "sendTemplate",
      "name": "Send Template",
      "description": "Send message based on template",
      "resource": "message"
    },
    {
      "operation": "sendHtml",
      "name": "Send HTML",
      "description": "Send message based on HTML",
      "resource": "message"
    }
  ]


node_type: nodes-base.mandrill
package_name: n8n-nodes-base
display_name: Mandrill
description: Consume Mandrill API
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "mandrillApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mandrill node documentation
  description: Learn how to use the Mandrill node in n8n. Follow technical documentation to integrate Mandrill node into your workflows.
  contentType: [integration, reference]
  ---

  # Mandrill node

  Use the Mandrill node to automate work in Mandrill, and integrate Mandrill with other applications. n8n supports sending messages based on templates or HTML with Mandrill.

  On this page, you'll find a list of operations the Mandrill node supports and links to more resources.

  /// note | Credentials
  Refer to [Mandrill credentials](/integrations/builtin/credentials/mandrill.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Message
      * Send message based on template.
      * Send message based on HTML.

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mandrill') ]]

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "message",
      "options": [
        {
          "name": "Message",
          "value": "message",
          "description": "Send a message"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "sendTemplate",
      "options": [
        {
          "name": "Send Template",
          "value": "sendTemplate",
          "description": "Send message based on template",
          "action": "Send a message based on a template"
        },
        {
          "name": "Send HTML",
          "value": "sendHtml",
          "description": "Send message based on HTML",
          "action": "Send a message based on HTML"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Template Name or ID",
      "name": "template",
      "type": "options",
      "default": "",
      "description": "The template you want to send. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "sendTemplate"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTemplates"
      }
    },
    {
      "displayName": "From Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender optional with name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "sendHtml",
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "To Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the recipient. Multiple ones can be separated by comma.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "sendHtml",
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "sendHtml",
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Async",
          "name": "async",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of \"queued\" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async."
        },
        {
          "displayName": "Auto Text",
          "name": "autoText",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to automatically generate a text part for messages that are not given text"
        },
        {
          "displayName": "Auto HTML",
          "name": "autoHtml",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to automatically generate an HTML part for messages that are not given HTML"
        },
        {
          "displayName": "BCC Address",
          "name": "bccAddress",
          "type": "string",
          "default": "",
          "placeholder": "message.bcc_address@example.com",
          "description": "An optional address to receive an exact copy of each recipient's email"
        },
        {
          "displayName": "From Name",
          "name": "fromName",
          "type": "string",
          "default": "",
          "placeholder": "John Doe",
          "description": "Optional from name to be used"
        },
        {
          "displayName": "Google Analytics Campaign",
          "name": "googleAnalyticsCampaign",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "Optional string indicating the value to set for the utm_campaign tracking parameter. If this isn't provided the email's from address will be used instead."
        },
        {
          "displayName": "Google Analytics Domains",
          "name": "googleAnalyticsDomains",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "An array of strings separated by a comma (,) indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically"
        },
        {
          "displayName": "HTML",
          "name": "html",
          "type": "string",
          "default": "",
          "typeOptions": {
            "rows": 5
          },
          "options": [],
          "description": "The html you want to send"
        },
        {
          "displayName": "Important",
          "name": "important",
          "type": "boolean",
          "default": false,
          "description": "Whether or not this message is important, and should be delivered ahead of non-important messages"
        },
        {
          "displayName": "Inline CSS",
          "name": "inlineCss",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size"
        },
        {
          "displayName": "Ip Pool",
          "name": "ipPool",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "The name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead."
        },
        {
          "displayName": "Preserve Recipients",
          "name": "preserveRecipients",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to expose all recipients in to \"To\" header for each email"
        },
        {
          "displayName": "Return Path Domain",
          "name": "returnPathDomain",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "A custom domain to use for the messages's return-path"
        },
        {
          "displayName": "Sent At",
          "name": "sendAt",
          "type": "dateTime",
          "default": "",
          "placeholder": "",
          "description": "When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately. An additional fee applies for scheduled email, and this feature is only available to accounts with a positive balance."
        },
        {
          "displayName": "Signing Domain",
          "name": "signingDomain",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "A custom domain to use for SPF/DKIM signing instead of mandrill(for \"via\" or \"on behalf of\" in email clients)"
        },
        {
          "displayName": "Subaccount",
          "name": "subAccount",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "The unique ID of a subaccount for this message - must already exist or will fail with an error"
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": "",
          "placeholder": "My subject line",
          "description": "Subject line of the email"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "An array of string separated by a comma (,) to tag the message with. Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors."
        },
        {
          "displayName": "Text",
          "name": "text",
          "type": "string",
          "default": "",
          "typeOptions": {
            "rows": 5
          },
          "options": [],
          "description": "Example text content"
        },
        {
          "displayName": "Track Clicks",
          "name": "trackClicks",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to turn on click tracking for the message"
        },
        {
          "displayName": "Track Opens",
          "name": "trackOpens",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to turn on open tracking for the message"
        },
        {
          "displayName": "Tracking Domain",
          "name": "trackingDomain",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "A custom domain to use for tracking opens and clicks instead of mandrillapp.com"
        },
        {
          "displayName": "Url Strip Qs",
          "name": "urlStripQs",
          "type": "boolean",
          "default": false,
          "description": "Whether or not to strip the query string from URLs when aggregating tracked URL data"
        },
        {
          "displayName": "View Content Link",
          "name": "viewContentLink",
          "type": "boolean",
          "default": false,
          "description": "Whether to remove content logging for sensitive emails"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "sendHtml",
            "sendTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Merge Vars",
      "name": "mergeVarsJson",
      "type": "json",
      "default": "",
      "description": "Global merge variables",
      "displayOptions": {
        "show": {
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Merge Vars",
      "name": "mergeVarsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Per-recipient merge variables",
      "options": [
        {
          "name": "mergeVarsValues",
          "displayName": "Vars",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Content",
              "name": "content",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadataUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval. In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.",
      "options": [
        {
          "name": "metadataValues",
          "displayName": "Metadata",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "Name of the metadata key to add."
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value to set for the metadata key"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadataJson",
      "type": "json",
      "default": "",
      "description": "Metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval. In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.",
      "displayOptions": {
        "show": {
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachmentsJson",
      "type": "json",
      "default": "",
      "description": "An array of supported attachments to add to the message",
      "displayOptions": {
        "show": {
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachmentsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Array of supported attachments to add to the message",
      "options": [
        {
          "name": "attachmentsValues",
          "displayName": "Attachments Values",
          "values": [
            {
              "displayName": "Type",
              "name": "type",
              "type": "string",
              "default": "",
              "placeholder": "text/plain",
              "description": "The MIME type of the attachment"
            },
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "placeholder": "myfile.txt",
              "description": "The file name of the attachment"
            },
            {
              "displayName": "Content",
              "name": "content",
              "type": "string",
              "default": "",
              "placeholder": "ZXhhbXBsZSBmaWxl",
              "description": "The content of the attachment as a base64-encoded string"
            }
          ]
        },
        {
          "name": "attachmentsBinary",
          "displayName": "Attachments Binary",
          "values": [
            {
              "displayName": "Property",
              "name": "property",
              "type": "string",
              "default": "",
              "description": "Name of the binary properties which contain data which should be added to email as attachment"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Headers",
      "name": "headersJson",
      "type": "json",
      "default": "",
      "description": "Optional extra headers to add to the message (most headers are allowed)",
      "displayOptions": {
        "show": {
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Headers",
      "name": "headersUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Optional extra headers to add to the message (most headers are allowed)",
      "options": [
        {
          "name": "headersValues",
          "displayName": "Values",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    }
  ]

operations:
  [
    {
      "operation": "sendTemplate",
      "name": "Send Template",
      "description": "Send message based on template",
      "resource": "message"
    },
    {
      "operation": "sendHtml",
      "name": "Send HTML",
      "description": "Send message based on HTML",
      "resource": "message"
    }
  ]


node_type: nodes-base.manualTrigger
package_name: n8n-nodes-base
display_name: Manual Trigger
description: Runs the flow on clicking a button in n8n
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
properties_schema:
  [
    {
      "displayName": "This node is where the workflow execution starts (when you click the ‘test’ button on the canvas).<br><br> <a data-action=\"showNodeCreator\">Explore other ways to trigger your workflow</a> (e.g on a schedule, or a webhook)",
      "name": "notice",
      "type": "notice",
      "default": ""
    }
  ]


node_type: nodes-base.markdown
package_name: n8n-nodes-base
display_name: Markdown
description: Convert data between Markdown and HTML
category: output
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Markdown
  description: Documentation for the Markdown node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # Markdown

  The Markdown node converts between Markdown and HTML formats.

  ## Operations

  This node's operations are **Modes**:

  * **Markdown to HTML**: Use this mode to convert from Markdown to HTML.
  * **HTML to Markdown**: Use this mode to convert from HTML to Markdown.

  ## Node parameters

  * **HTML** or **Markdown**: Enter the data you want to convert. The field name changes based on which **Mode** you select.
  * **Destination Key**: Enter the field you want to put the output in. Specify nested fields using dots, for example `level1.level2.newKey`.

  ## Node options

  The node's **Options** depend on the **Mode** selected.

  /// note | Test out the options
  Some of the options depend on each other or can interact. We recommend testing out options to confirm the effects are what you want.
  ///

  ### Markdown to HTML options

  | Option | Description | Default |
  | ------ | ----------- | ------- |
  | **Add Blank To Links** | Whether to open links a new window (enabled) or not (disabled). | Disabled |
  | **Automatic Linking To URLs** | Whether to automatically link to URLs (enabled) or not (disabled). If enabled, n8n converts any string that it identifies as a URL to a link. | Disabled |
  | **Backslash Escapes HTML Tags** | Whether to allow backslash escaping of HTML tags (enabled) or not (disabled). When enabled, n8n escapes any `<` or `>` prefaced with `\`. For example, `\<div\>` renders as `&lt;div&gt;`.  | Disabled |
  | **Complete HTML Document** | Whether to output a complete HTML document (enabled) or an HTML fragment (disabled). A complete HTML document includes the `<DOCTYPE HTML>` declaration, `<html>` and `<body>` tags, and the `<head>` element.  | Disabled |
  | **Customized Header ID** | Whether to support custom heading IDs (enabled) or not (disabled). When enabled, you can add custom heading IDs using `{header ID here}` after the heading text. | Disabled |
  | **Emoji Support** | Whether to support emojis (enabled) or not (disabled). | Disabled. |
  | **Encode Emails** | Whether to transform ASCII character emails into their equivalent decimal entities (enabled) or not (disabled). | Enabled | 
  | **Exclude Trailing Punctuation From URLs** | Whether to exclude trailing punctuation from automatically linked URLs (enabled) or not (disabled). For use with **Automatic Linking To URLs**. | Disabled |
  | **GitHub Code Blocks** | Whether to enable GitHub Flavored Markdown code blocks (enabled) or not (disabled). | Enabled |
  | **GitHub Compatible Header IDs** | Whether to generate GitHub Flavored Markdown heading IDs (enabled) or not (disabled). GitHub Flavored Markdown generates heading IDs with `-` in place of spaces and removes non-alphanumeric characters. | Disabled |
  | **GitHub Mention Link** | Change the link used with **GitHub Mentions**.  | Disabled |
  | **GitHub Mentions** | Whether to support tagging GitHub users with `@` (enabled) or not (disabled). When enabled, n8n replaces `@name` with `https://github.com/name`. | Disabled |
  | **GitHub Task Lists** | Whether to support GitHub Flavored Markdown task lists (enabled) or not (disabled). | Disabled |
  | **Header Level Start** | Number. Set the start level for headers. For example, changing this field to `2` causes n8n to treat `#` as `<h2>`, `##` as `<h3>`, and so on. | 1 |
  | **Mandatory Space Before Header** | Whether to make a space between `#` and heading text required (enabled) or not (disabled). When enabled, n8n renders a heading written as `##Some header text` literally (it doesn't turn it into a heading element) | Disabled |
  | **Middle Word Asterisks** | Whether n8n should treat asterisks in words as Markdown (disabled) or render them as literal asterisks (enabled). | Disabled |
  | **Middle Word Underscores** | Whether n8n should treat underscores in words as Markdown (disabled) or render them as literal underscores (enabled). | Disabled |
  | **No Header ID** | Disable automatic generation of header IDs (enabled). | Disabled |
  | **Parse Image Dimensions** | Support setting maximum image dimensions in Markdown syntax (enabled). | Disabled |
  | **Prefix Header ID** | Define a prefix to add to header IDs. | None |
  | **Raw Header ID** | Whether to remove spaces, `'`, and `"` from header IDs, including prefixes, replacing them with `-` (enabled) or not (disabled). | Disabled |
  | **Raw Prefix Header ID** | Whether to prevent n8n from modifying header prefixes (enabled) or not (disabled) | Disabled |
  | **Simple Line Breaks** | Whether to create line breaks without a double space at the end of a line (enabled) or not (disabled). | Disabled |
  | **Smart Indentation Fix** | Whether to try to smartly fix indentation problems related to ES6 template strings in indented code blocks (enabled) or not (disabled). | Disabled |
  | **Spaces Indented Sublists** | Whether to remove the requirement to indent sublists four spaces (enabled) or not (disabled). | Disabled |
  | **Split Adjacent Blockquotes** | Whether to split adjacent blockquote blocks (enabled) or not (disabled). If you don't enable this, n8n treats quotes (indicated by `>` at the start of the line) on separate lines as a single blockquote, even when separated by an empty line.  | Disabled |
  | **Strikethrough** | Whether to support strikethrough syntax (enabled) or not (disabled). When enabled, you can add a ~~strikethrough~~ effect using `~~` around the word or phrase. | Disabled |
  | **Tables Header ID** | Whether to add an ID to table header tags (enabled) or not (disabled). | Disabled |
  | **Tables Support** | Whether to support tables (enabled) or not (disabled). | Disabled |

  ### HTML to Markdown options

  | Option | Description | Default |
  | ------ | ----------- | ------- |
  | **Bullet Marker** | Specify the character to use for unordered lists. | * |
  | **Code Block Fence** | Specify the characters to use for code blocks. | ``` |
  | **Emphasis Delimiter** | Specify the character `<em>`. | _ |
  | **Global Escape Pattern** | Overrides the default character escape settings. You may want to use Text Replacement Pattern instead. | None |
  | **Ignored Elements** | Ignore given HTML elements, and their children. | None |
  | **Keep Images With Data** | Whether to keep images with data (enabled) or not (disabled). Support files up to 1MB. | Disabled |
  | **Line Start Escape Pattern** | Overrides the default character escape settings. You may want to use Text Replacement Pattern instead. | None |
  | **Max Consecutive New Lines** | Number. Specify the maximum number of consecutive new lines allowed. | 3 |
  | **Place URLs At The Bottom** | Whether to place URLs at the bottom of the page and format using link reference definitions (enabled) or not (disabled). | Disabled |
  | **Strong Delimiter** | Specify the characters for `<strong>`. | ** |
  | **Style For Code Block** | Specify the styling for code blocks. Options are **Fence** and **Indented**. | Fence |
  | **Text Replacement Pattern** | Define a text replacement pattern using regex. | None |
  | **Treat As Blocks** | Specify HTML elements to treat as blocks (surround with blank lines) | None |

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'markdown') ]]

  ## Parsers

  n8n uses the following parsers:

  * To convert from HTML to Markdown: [node-html-markdown](https://www.npmjs.com/package/node-html-markdown){:target=_blank .external-link}.
  * To convert from Markdown to HTML: [Showdown](https://www.npmjs.com/package/showdown){:target=_blank .external-link}. Some options allow you to extend your Markdown with [GitHub Flavored Markdown](https://github.github.com/gfm/){:target=_blank .external-link}.

properties_schema:
  [
    {
      "displayName": "Mode",
      "name": "mode",
      "type": "options",
      "default": "htmlToMarkdown",
      "options": [
        {
          "name": "Markdown to HTML",
          "value": "markdownToHtml",
          "description": "Convert data from Markdown to HTML"
        },
        {
          "name": "HTML to Markdown",
          "value": "htmlToMarkdown",
          "description": "Convert data from HTML to Markdown"
        }
      ]
    },
    {
      "displayName": "HTML",
      "name": "html",
      "type": "string",
      "default": "",
      "description": "The HTML to be converted to markdown",
      "required": true,
      "displayOptions": {
        "show": {
          "mode": [
            "htmlToMarkdown"
          ]
        }
      }
    },
    {
      "displayName": "Markdown",
      "name": "markdown",
      "type": "string",
      "default": "",
      "description": "The Markdown to be converted to html",
      "required": true,
      "displayOptions": {
        "show": {
          "mode": [
            "markdownToHtml"
          ]
        }
      }
    },
    {
      "displayName": "Destination Key",
      "name": "destinationKey",
      "type": "string",
      "default": "data",
      "description": "The field to put the output in. Specify nested fields using dots, e.g.\"level1.level2.newKey\".",
      "required": true,
      "displayOptions": {
        "show": {
          "mode": [
            "markdownToHtml",
            "htmlToMarkdown"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bullet Marker",
          "name": "bulletMarker",
          "type": "string",
          "default": "*",
          "description": "Specify bullet marker, default *"
        },
        {
          "displayName": "Code Block Fence",
          "name": "codeFence",
          "type": "string",
          "default": "```",
          "description": "Specify code block fence, default ```"
        },
        {
          "displayName": "Emphasis Delimiter",
          "name": "emDelimiter",
          "type": "string",
          "default": "_",
          "description": "Specify emphasis delimiter, default _"
        },
        {
          "displayName": "Global Escape Pattern",
          "name": "globalEscape",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "description": "Setting this will override the default escape settings, you might want to use textReplace option instead",
          "options": [
            {
              "name": "value",
              "displayName": "Value",
              "values": [
                {
                  "displayName": "Pattern",
                  "name": "pattern",
                  "type": "string",
                  "default": "",
                  "description": "RegEx for pattern"
                },
                {
                  "displayName": "Replacement",
                  "name": "replacement",
                  "type": "string",
                  "default": "",
                  "description": "String replacement"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Ignored Elements",
          "name": "ignore",
          "type": "string",
          "default": "",
          "description": "Supplied elements will be ignored (ignores inner text does not parse children)",
          "placeholder": "e.g. h1, p ...",
          "hint": "Comma separated elements"
        },
        {
          "displayName": "Keep Images With Data",
          "name": "keepDataImages",
          "type": "boolean",
          "default": false,
          "description": "Whether to keep images with data: URI (Note: These can be up to 1MB each), e.g. &lt;img src=\"data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSK......0o/\"&gt;"
        },
        {
          "displayName": "Line Start Escape Pattern",
          "name": "lineStartEscape",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "description": "Setting this will override the default escape settings, you might want to use textReplace option instead",
          "options": [
            {
              "name": "value",
              "displayName": "Value",
              "values": [
                {
                  "displayName": "Pattern",
                  "name": "pattern",
                  "type": "string",
                  "default": "",
                  "description": "RegEx for pattern"
                },
                {
                  "displayName": "Replacement",
                  "name": "replacement",
                  "type": "string",
                  "default": "",
                  "description": "String replacement"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Max Consecutive New Lines",
          "name": "maxConsecutiveNewlines",
          "type": "number",
          "default": 3,
          "description": "Specify max consecutive new lines allowed"
        },
        {
          "displayName": "Place URLs At The Bottom",
          "name": "useLinkReferenceDefinitions",
          "type": "boolean",
          "default": false,
          "description": "Whether to Place URLS at the bottom and format links using link reference definitions"
        },
        {
          "displayName": "Strong Delimiter",
          "name": "strongDelimiter",
          "type": "string",
          "default": "**",
          "description": "Specify strong delimiter, default **"
        },
        {
          "displayName": "Style For Code Block",
          "name": "codeBlockStyle",
          "type": "options",
          "default": "fence",
          "description": "Specify style for code block, default \"fence\"",
          "options": [
            {
              "name": "Fence",
              "value": "fence"
            },
            {
              "name": "Indented",
              "value": "indented"
            }
          ]
        },
        {
          "displayName": "Text Replacement Pattern",
          "name": "textReplace",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": [],
          "description": "User-defined text replacement pattern (Replaces matching text retrieved from nodes)",
          "options": [
            {
              "name": "values",
              "displayName": "Values",
              "values": [
                {
                  "displayName": "Pattern",
                  "name": "pattern",
                  "type": "string",
                  "default": "",
                  "description": "RegEx for pattern"
                },
                {
                  "displayName": "Replacement",
                  "name": "replacement",
                  "type": "string",
                  "default": "",
                  "description": "String replacement"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Treat As Blocks",
          "name": "blockElements",
          "type": "string",
          "default": "",
          "description": "Supplied elements will be treated as blocks (surrounded with blank lines)",
          "placeholder": "e.g. p, div, ...",
          "hint": "Comma separated elements"
        }
      ],
      "displayOptions": {
        "show": {
          "mode": [
            "htmlToMarkdown"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Add Blank To Links",
          "name": "openLinksInNewWindow",
          "type": "boolean",
          "default": false,
          "description": "Whether to open all links in new windows (by adding the attribute target=\"_blank\" to <a> tags)"
        },
        {
          "displayName": "Automatic Linking to URLs",
          "name": "simplifiedAutoLink",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable automatic linking to URLs"
        },
        {
          "displayName": "Backslash Escapes HTML Tags",
          "name": "backslashEscapesHTMLTags",
          "type": "boolean",
          "default": false,
          "description": "Whether to support for HTML Tag escaping ex: &lt;div&gt;foo&lt;/div&gt;"
        },
        {
          "displayName": "Complete HTML Document",
          "name": "completeHTMLDocument",
          "type": "boolean",
          "default": false,
          "description": "Whether to output a complete html document, including &lt;html&gt;, &lt;head&gt; and &lt;body&gt; tags instead of an HTML fragment"
        },
        {
          "displayName": "Customized Header ID",
          "name": "customizedHeaderId",
          "type": "boolean",
          "default": false,
          "description": "Whether to use text in curly braces as header ID"
        },
        {
          "displayName": "Emoji Support",
          "name": "emoji",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable emoji support. Ex: this is a :smile: emoji For more info on available emojis, see https://github.com/showdownjs/showdown/wiki/Emojis."
        },
        {
          "displayName": "Encode Emails",
          "name": "encodeEmails",
          "type": "boolean",
          "default": true,
          "description": "Whether to enable e-mail addresses encoding through the use of Character Entities, transforming ASCII e-mail addresses into its equivalent decimal entities"
        },
        {
          "displayName": "Exclude Trailing Punctuation From URLs",
          "name": "excludeTrailingPunctuationFromURLs",
          "type": "boolean",
          "default": false,
          "description": "Whether to exclude trailing punctuation from autolinking URLs. Punctuation excluded: . ! ? ( ). Only applies if simplifiedAutoLink option is set to true."
        },
        {
          "displayName": "GitHub Code Blocks",
          "name": "ghCodeBlocks",
          "type": "boolean",
          "default": true,
          "description": "Whether to enable support for GFM code block style"
        },
        {
          "displayName": "GitHub Compatible Header IDs",
          "name": "ghCompatibleHeaderId",
          "type": "boolean",
          "default": false,
          "description": "Whether to generate header IDs compatible with github style (spaces are replaced with dashes and a bunch of non alphanumeric chars are removed)"
        },
        {
          "displayName": "GitHub Mention Link",
          "name": "ghMentionsLink",
          "type": "string",
          "default": "https://github.com/{u}",
          "description": "Whether to change the link generated by @mentions. Showdown will replace {u} with the username. Only applies if ghMentions option is enabled."
        },
        {
          "displayName": "GitHub Mentions",
          "name": "ghMentions",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable github @mentions, which link to the username mentioned"
        },
        {
          "displayName": "GitHub Task Lists",
          "name": "tasklists",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable support for GFM tasklists"
        },
        {
          "displayName": "Header Level Start",
          "name": "headerLevelStart",
          "type": "number",
          "default": 1,
          "description": "Whether to set the header starting level"
        },
        {
          "displayName": "Mandatory Space Before Header",
          "name": "requireSpaceBeforeHeadingText",
          "type": "boolean",
          "default": false,
          "description": "Whether to make adding a space between # and the header text mandatory"
        },
        {
          "displayName": "Middle Word Asterisks",
          "name": "literalMidWordAsterisks",
          "type": "boolean",
          "default": false,
          "description": "Whether to stop showdown from interpreting asterisks in the middle of words as <em> and <strong> and instead treat them as literal asterisks"
        },
        {
          "displayName": "Middle Word Underscores",
          "name": "literalMidWordUnderscores",
          "type": "boolean",
          "default": false,
          "description": "Whether to stop showdown from interpreting underscores in the middle of words as <em> and <strong> and instead treat them as literal underscores"
        },
        {
          "displayName": "No Header ID",
          "name": "noHeaderId",
          "type": "boolean",
          "default": false,
          "description": "Whether to disable the automatic generation of header IDs"
        },
        {
          "displayName": "Parse Image Dimensions",
          "name": "parseImgDimensions",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable support for setting image dimensions from within markdown syntax"
        },
        {
          "displayName": "Prefix Header ID",
          "name": "prefixHeaderId",
          "type": "string",
          "default": "section",
          "description": "Add a prefix to the generated header IDs"
        },
        {
          "displayName": "Raw Header ID",
          "name": "rawHeaderId",
          "type": "boolean",
          "default": false,
          "description": "Whether to remove only spaces, ' and \" from generated header IDs (including prefixes), replacing them with dashes (-)"
        },
        {
          "displayName": "Raw Prefix Header ID",
          "name": "rawPrefixHeaderId",
          "type": "boolean",
          "default": false,
          "description": "Whether to prevent showdown from modifying the prefix"
        },
        {
          "displayName": "Simple Line Breaks",
          "name": "simpleLineBreaks",
          "type": "boolean",
          "default": false,
          "description": "Whether to parse line breaks as &lt;br&gt;, like GitHub does, without needing 2 spaces at the end of the line"
        },
        {
          "displayName": "Smart Indentation Fix",
          "name": "smartIndentationFix",
          "type": "boolean",
          "default": false,
          "description": "Whether to try to smartly fix indentation problems related to es6 template strings in the midst of indented code"
        },
        {
          "displayName": "Spaces Indented Sublists",
          "name": "disableForced4SpacesIndentedSublists",
          "type": "boolean",
          "default": false,
          "description": "Whether to disable the requirement of indenting sublists by 4 spaces for them to be nested, effectively reverting to the old behavior where 2 or 3 spaces were enough"
        },
        {
          "displayName": "Split Adjacent Blockquotes",
          "name": "splitAdjacentBlockquotes",
          "type": "boolean",
          "default": false,
          "description": "Whether to split adjacent blockquote blocks"
        },
        {
          "displayName": "Strikethrough",
          "name": "strikethrough",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable support for strikethrough syntax"
        },
        {
          "displayName": "Tables Header ID",
          "name": "tablesHeaderId",
          "type": "boolean",
          "default": false,
          "description": "Whether to add an ID property to table headers tags"
        },
        {
          "displayName": "Tables Support",
          "name": "tables",
          "type": "boolean",
          "default": false,
          "description": "Whether to enable support for tables syntax"
        }
      ],
      "displayOptions": {
        "show": {
          "mode": [
            "markdownToHtml"
          ]
        }
      }
    }
  ]


node_type: nodes-base.marketstackTool
package_name: n8n-nodes-base
display_name: Marketstack Tool
description: Consume Marketstack API (AI Tool variant for use with AI Agents)
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "marketstackApi",
  "required": true
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.marketstack
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: marketstack node documentation
  description: Learn how to use the marketstack node in n8n. Follow technical documentation to integrate marketstack node into your workflows.
  contentType: [integration, reference]
  ---
  <!-- marketstack is not a typo. The brand name is all lowercase, so we match it -->
  # marketstack node

  Use the marketstack node to automate work in marketstack, and integrate marketstack with other applications. n8n has built-in support for a wide range of marketstack features, including getting exchanges, end-of-day data, and tickers. 

  On this page, you'll find a list of operations the marketstack node supports and links to more resources.

  /// note | Credentials
  Refer to [marketstack credentials](/integrations/builtin/credentials/marketstack.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * End-of-Day Data
      * Get All
  * Exchange
      * Get
  * Ticker
      * Get

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'marketstack') ]]

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Marketstack"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "endOfDayData",
      "options": [
        {
          "name": "End-of-Day Data",
          "value": "endOfDayData",
          "description": "Stock market closing data"
        },
        {
          "name": "Exchange",
          "value": "exchange",
          "description": "Stock market exchange"
        },
        {
          "name": "Ticker",
          "value": "ticker",
          "description": "Stock market symbol"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many EoD data"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Ticker",
      "name": "symbols",
      "type": "string",
      "default": "",
      "description": "One or multiple comma-separated stock symbols (tickers) to retrieve, e.g. <code>AAPL</code> or <code>AAPL,MSFT</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exchange",
          "name": "exchange",
          "type": "string",
          "default": "",
          "description": "Stock exchange to filter results by, specified by <a href=\"https://en.wikipedia.org/wiki/Market_Identifier_Code\">Market Identifier Code</a>, e.g. <code>XNAS</code>"
        },
        {
          "displayName": "Latest",
          "name": "latest",
          "type": "boolean",
          "default": false,
          "description": "Whether to fetch the most recent stock market data"
        },
        {
          "displayName": "Sort Order",
          "name": "sort",
          "description": "Order to sort results in",
          "type": "options",
          "options": [
            {
              "name": "Ascending",
              "value": "ASC"
            },
            {
              "name": "Descending",
              "value": "DESC"
            }
          ],
          "default": "DESC"
        },
        {
          "displayName": "Specific Date",
          "name": "specificDate",
          "type": "dateTime",
          "default": "",
          "description": "Date in YYYY-MM-DD format, e.g. <code>2020-01-01</code>, or in ISO-8601 date format, e.g. <code>2020-05-21T00:00:00+0000</code>"
        },
        {
          "displayName": "Timeframe Start Date",
          "name": "dateFrom",
          "type": "dateTime",
          "default": "",
          "description": "Timeframe start date in YYYY-MM-DD format, e.g. <code>2020-01-01</code>, or in ISO-8601 date format, e.g. <code>2020-05-21T00:00:00+0000</code>"
        },
        {
          "displayName": "Timeframe End Date",
          "name": "dateTo",
          "type": "dateTime",
          "default": "",
          "description": "Timeframe end date in YYYY-MM-DD format, e.g. <code>2020-01-01</code>, or in ISO-8601 date format, e.g. <code>2020-05-21T00:00:00+0000</code>"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get an exchange"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "exchange"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Exchange",
      "name": "exchange",
      "type": "string",
      "default": "",
      "description": "Stock exchange to retrieve, specified by <a href=\"https://en.wikipedia.org/wiki/Market_Identifier_Code\">Market Identifier Code</a>, e.g. <code>XNAS</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "exchange"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a ticker"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticker"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Ticker",
      "name": "symbol",
      "type": "string",
      "default": "",
      "description": "Stock symbol (ticker) to retrieve, e.g. <code>AAPL</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticker"
          ],
          "operation": [
            "get"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "endOfDayData"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "exchange"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "ticker"
    }
  ]


node_type: nodes-base.marketstack
package_name: n8n-nodes-base
display_name: Marketstack
description: Consume Marketstack API
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "marketstackApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: marketstack node documentation
  description: Learn how to use the marketstack node in n8n. Follow technical documentation to integrate marketstack node into your workflows.
  contentType: [integration, reference]
  ---
  <!-- marketstack is not a typo. The brand name is all lowercase, so we match it -->
  # marketstack node

  Use the marketstack node to automate work in marketstack, and integrate marketstack with other applications. n8n has built-in support for a wide range of marketstack features, including getting exchanges, end-of-day data, and tickers. 

  On this page, you'll find a list of operations the marketstack node supports and links to more resources.

  /// note | Credentials
  Refer to [marketstack credentials](/integrations/builtin/credentials/marketstack.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * End-of-Day Data
      * Get All
  * Exchange
      * Get
  * Ticker
      * Get

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'marketstack') ]]

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "endOfDayData",
      "options": [
        {
          "name": "End-of-Day Data",
          "value": "endOfDayData",
          "description": "Stock market closing data"
        },
        {
          "name": "Exchange",
          "value": "exchange",
          "description": "Stock market exchange"
        },
        {
          "name": "Ticker",
          "value": "ticker",
          "description": "Stock market symbol"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many EoD data"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Ticker",
      "name": "symbols",
      "type": "string",
      "default": "",
      "description": "One or multiple comma-separated stock symbols (tickers) to retrieve, e.g. <code>AAPL</code> or <code>AAPL,MSFT</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exchange",
          "name": "exchange",
          "type": "string",
          "default": "",
          "description": "Stock exchange to filter results by, specified by <a href=\"https://en.wikipedia.org/wiki/Market_Identifier_Code\">Market Identifier Code</a>, e.g. <code>XNAS</code>"
        },
        {
          "displayName": "Latest",
          "name": "latest",
          "type": "boolean",
          "default": false,
          "description": "Whether to fetch the most recent stock market data"
        },
        {
          "displayName": "Sort Order",
          "name": "sort",
          "description": "Order to sort results in",
          "type": "options",
          "options": [
            {
              "name": "Ascending",
              "value": "ASC"
            },
            {
              "name": "Descending",
              "value": "DESC"
            }
          ],
          "default": "DESC"
        },
        {
          "displayName": "Specific Date",
          "name": "specificDate",
          "type": "dateTime",
          "default": "",
          "description": "Date in YYYY-MM-DD format, e.g. <code>2020-01-01</code>, or in ISO-8601 date format, e.g. <code>2020-05-21T00:00:00+0000</code>"
        },
        {
          "displayName": "Timeframe Start Date",
          "name": "dateFrom",
          "type": "dateTime",
          "default": "",
          "description": "Timeframe start date in YYYY-MM-DD format, e.g. <code>2020-01-01</code>, or in ISO-8601 date format, e.g. <code>2020-05-21T00:00:00+0000</code>"
        },
        {
          "displayName": "Timeframe End Date",
          "name": "dateTo",
          "type": "dateTime",
          "default": "",
          "description": "Timeframe end date in YYYY-MM-DD format, e.g. <code>2020-01-01</code>, or in ISO-8601 date format, e.g. <code>2020-05-21T00:00:00+0000</code>"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "endOfDayData"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get an exchange"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "exchange"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Exchange",
      "name": "exchange",
      "type": "string",
      "default": "",
      "description": "Stock exchange to retrieve, specified by <a href=\"https://en.wikipedia.org/wiki/Market_Identifier_Code\">Market Identifier Code</a>, e.g. <code>XNAS</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "exchange"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a ticker"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticker"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Ticker",
      "name": "symbol",
      "type": "string",
      "default": "",
      "description": "Stock symbol (ticker) to retrieve, e.g. <code>AAPL</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticker"
          ],
          "operation": [
            "get"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "endOfDayData"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "exchange"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "ticker"
    }
  ]


node_type: nodes-base.matrixTool
package_name: n8n-nodes-base
display_name: Matrix Tool
description: Consume Matrix API (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "matrixApi",
  "required": true
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.matrix
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Matrix node documentation
  description: Learn how to use the Matrix node in n8n. Follow technical documentation to integrate Matrix node into your workflows.
  contentType: [integration, reference]
  ---

  # Matrix node

  Use the Matrix node to automate work in Matrix, and integrate Matrix with other applications. n8n has built-in support for a wide range of Matrix features, including getting current user's account information, sending media and messages to a room, and getting room members and messages.

  On this page, you'll find a list of operations the Matrix node supports and links to more resources.

  /// note | Credentials
  Refer to [Matrix credentials](/integrations/builtin/credentials/matrix.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Account
      * Get current user's account information
  * Event
      * Get single event by ID
  * Media
      * Send media to a chat room
  * Message
      * Send a message to a room
      * Gets all messages from a room
  * Room
      * New chat room with defined settings
      * Invite a user to a room
      * Join a new room
      * Kick a user from a room
      * Leave a room
  * Room Member
      * Get all members

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'matrix') ]]

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Matrix"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "message",
      "options": [
        {
          "name": "Account",
          "value": "account"
        },
        {
          "name": "Event",
          "value": "event"
        },
        {
          "name": "Media",
          "value": "media"
        },
        {
          "name": "Message",
          "value": "message"
        },
        {
          "name": "Room",
          "value": "room"
        },
        {
          "name": "Room Member",
          "value": "roomMember"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "me",
      "options": [
        {
          "name": "Me",
          "value": "me",
          "description": "Get current user's account information",
          "action": "Get the current user's account information"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "account"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get single event by ID",
          "action": "Get an event by ID"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room ID",
      "name": "roomId",
      "type": "string",
      "default": "",
      "description": "The room related to the event",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Event ID",
      "name": "eventId",
      "type": "string",
      "default": "",
      "description": "The room related to the event",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upload",
      "options": [
        {
          "name": "Upload",
          "value": "upload",
          "description": "Send media to a chat room",
          "action": "Upload media to a chatroom"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "media"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "type": "options",
      "default": "",
      "description": "Room ID to post. 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": [
            "media"
          ],
          "operation": [
            "upload"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "media"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Media Type",
      "name": "mediaType",
      "type": "options",
      "default": "image",
      "description": "Type of file being uploaded",
      "options": [
        {
          "name": "File",
          "value": "file",
          "description": "General file"
        },
        {
          "name": "Image",
          "value": "image",
          "description": "Image media type"
        },
        {
          "name": "Audio",
          "value": "audio",
          "description": "Audio media type"
        },
        {
          "name": "Video",
          "value": "video",
          "description": "Video media type"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "media"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "File Name",
          "name": "fileName",
          "type": "string",
          "default": "",
          "description": "Name of the file being uploaded"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "media"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Send a message to a room",
          "action": "Create a message"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many messages from a room",
          "action": "Get many messages"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "type": "options",
      "default": "",
      "description": "The channel to send the message to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "message"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "The text to send",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "Message Type",
      "name": "messageType",
      "type": "options",
      "default": "m.text",
      "description": "The type of message to send",
      "options": [
        {
          "name": "Emote",
          "value": "m.emote",
          "description": "Perform an action (similar to /me in IRC)"
        },
        {
          "name": "Notice",
          "value": "m.notice",
          "description": "Send a notice"
        },
        {
          "name": "Text",
          "value": "m.text",
          "description": "Send a text message"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "Message Format",
      "name": "messageFormat",
      "type": "options",
      "default": "plain",
      "description": "The format of the message's body",
      "options": [
        {
          "name": "Plain Text",
          "value": "plain",
          "description": "Text only"
        },
        {
          "name": "HTML",
          "value": "org.matrix.custom.html",
          "description": "HTML-formatted text"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "Fallback Text",
      "name": "fallbackText",
      "type": "string",
      "default": "",
      "description": "A plain text message to display in case the HTML cannot be rendered by the Matrix client",
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "create"
          ],
          "messageFormat": [
            "org.matrix.custom.html"
          ]
        }
      }
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "type": "options",
      "default": "",
      "description": "The token to start returning events from. This token can be obtained from a prev_batch token returned for each room by the sync API. 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": [
            "message"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Other Options",
      "name": "otherOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Filter",
          "name": "filter",
          "type": "string",
          "default": "",
          "description": "A JSON RoomEventFilter to filter returned events with. More information can be found on this <a href=\"https://matrix.org/docs/spec/client_server/r0.6.0\">page</a>.",
          "placeholder": "{\"contains_url\":true,\"types\":[\"m.room.message\", \"m.sticker\"]}"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "New chat room with defined settings",
          "action": "Create a room"
        },
        {
          "name": "Invite",
          "value": "invite",
          "description": "Invite a user to a room",
          "action": "Invite a room"
        },
        {
          "name": "Join",
          "value": "join",
          "description": "Join a new room",
          "action": "Join a room"
        },
        {
          "name": "Kick",
          "value": "kick",
          "description": "Kick a user from a room",
          "action": "Kick a user from a room"
        },
        {
          "name": "Leave",
          "value": "leave",
          "description": "Leave a room",
          "action": "Leave a room"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room Name",
      "name": "roomName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Preset",
      "name": "preset",
      "type": "options",
      "default": "public_chat",
      "options": [
        {
          "name": "Private Chat",
          "value": "private_chat"
        },
        {
          "name": "Public Chat",
          "value": "public_chat",
          "description": "Open and public chat"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Room Alias",
      "name": "roomAlias",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Room ID or Alias",
      "name": "roomIdOrAlias",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "join"
          ]
        }
      }
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "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": [
            "room"
          ],
          "operation": [
            "leave"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "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": [
            "room"
          ],
          "operation": [
            "invite"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "The fully qualified user ID of the invitee",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "invite"
          ]
        }
      }
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "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": [
            "room"
          ],
          "operation": [
            "kick"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "The fully qualified user ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "kick"
          ]
        }
      }
    },
    {
      "displayName": "Reason",
      "name": "reason",
      "type": "string",
      "default": "",
      "description": "Reason for kick",
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "kick"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many members",
          "action": "Get many room members"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "roomMember"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "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": [
            "roomMember"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "description": "Filtering options",
      "options": [
        {
          "displayName": "Exclude Membership",
          "name": "notMembership",
          "type": "options",
          "default": "",
          "description": "Excludes members whose membership is other than selected (uses OR filter with membership)",
          "options": [
            {
              "name": "Any",
              "value": "",
              "description": "Any user membership"
            },
            {
              "name": "Ban",
              "value": "ban",
              "description": "Users removed from the room"
            },
            {
              "name": "Invite",
              "value": "invite",
              "description": "Users invited to join"
            },
            {
              "name": "Join",
              "value": "join",
              "description": "Users currently in the room"
            },
            {
              "name": "Leave",
              "value": "leave",
              "description": "Users who left"
            }
          ]
        },
        {
          "displayName": "Membership",
          "name": "membership",
          "type": "options",
          "default": "",
          "description": "Only fetch users with selected membership status (uses OR filter with exclude membership)",
          "options": [
            {
              "name": "Any",
              "value": "",
              "description": "Any user membership"
            },
            {
              "name": "Ban",
              "value": "ban",
              "description": "Users removed from the room"
            },
            {
              "name": "Invite",
              "value": "invite",
              "description": "Users invited to join"
            },
            {
              "name": "Join",
              "value": "join",
              "description": "Users currently in the room"
            },
            {
              "name": "Leave",
              "value": "leave",
              "description": "Users who left"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "roomMember"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "me",
      "name": "Me",
      "description": "Get current user's account information",
      "resource": "account"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get single event by ID",
      "resource": "event"
    },
    {
      "operation": "upload",
      "name": "Upload",
      "description": "Send media to a chat room",
      "resource": "media"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Send a message to a room",
      "resource": "message"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many messages from a room",
      "resource": "message"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "New chat room with defined settings",
      "resource": "room"
    },
    {
      "operation": "invite",
      "name": "Invite",
      "description": "Invite a user to a room",
      "resource": "room"
    },
    {
      "operation": "join",
      "name": "Join",
      "description": "Join a new room",
      "resource": "room"
    },
    {
      "operation": "kick",
      "name": "Kick",
      "description": "Kick a user from a room",
      "resource": "room"
    },
    {
      "operation": "leave",
      "name": "Leave",
      "description": "Leave a room",
      "resource": "room"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many members",
      "resource": "roomMember"
    }
  ]


node_type: nodes-base.matrix
package_name: n8n-nodes-base
display_name: Matrix
description: Consume Matrix API
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "matrixApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Matrix node documentation
  description: Learn how to use the Matrix node in n8n. Follow technical documentation to integrate Matrix node into your workflows.
  contentType: [integration, reference]
  ---

  # Matrix node

  Use the Matrix node to automate work in Matrix, and integrate Matrix with other applications. n8n has built-in support for a wide range of Matrix features, including getting current user's account information, sending media and messages to a room, and getting room members and messages.

  On this page, you'll find a list of operations the Matrix node supports and links to more resources.

  /// note | Credentials
  Refer to [Matrix credentials](/integrations/builtin/credentials/matrix.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Account
      * Get current user's account information
  * Event
      * Get single event by ID
  * Media
      * Send media to a chat room
  * Message
      * Send a message to a room
      * Gets all messages from a room
  * Room
      * New chat room with defined settings
      * Invite a user to a room
      * Join a new room
      * Kick a user from a room
      * Leave a room
  * Room Member
      * Get all members

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'matrix') ]]

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "message",
      "options": [
        {
          "name": "Account",
          "value": "account"
        },
        {
          "name": "Event",
          "value": "event"
        },
        {
          "name": "Media",
          "value": "media"
        },
        {
          "name": "Message",
          "value": "message"
        },
        {
          "name": "Room",
          "value": "room"
        },
        {
          "name": "Room Member",
          "value": "roomMember"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "me",
      "options": [
        {
          "name": "Me",
          "value": "me",
          "description": "Get current user's account information",
          "action": "Get the current user's account information"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "account"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get single event by ID",
          "action": "Get an event by ID"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room ID",
      "name": "roomId",
      "type": "string",
      "default": "",
      "description": "The room related to the event",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Event ID",
      "name": "eventId",
      "type": "string",
      "default": "",
      "description": "The room related to the event",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upload",
      "options": [
        {
          "name": "Upload",
          "value": "upload",
          "description": "Send media to a chat room",
          "action": "Upload media to a chatroom"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "media"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "type": "options",
      "default": "",
      "description": "Room ID to post. 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": [
            "media"
          ],
          "operation": [
            "upload"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "media"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Media Type",
      "name": "mediaType",
      "type": "options",
      "default": "image",
      "description": "Type of file being uploaded",
      "options": [
        {
          "name": "File",
          "value": "file",
          "description": "General file"
        },
        {
          "name": "Image",
          "value": "image",
          "description": "Image media type"
        },
        {
          "name": "Audio",
          "value": "audio",
          "description": "Audio media type"
        },
        {
          "name": "Video",
          "value": "video",
          "description": "Video media type"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "media"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "File Name",
          "name": "fileName",
          "type": "string",
          "default": "",
          "description": "Name of the file being uploaded"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "media"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Send a message to a room",
          "action": "Create a message"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many messages from a room",
          "action": "Get many messages"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "type": "options",
      "default": "",
      "description": "The channel to send the message to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "message"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "The text to send",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "Message Type",
      "name": "messageType",
      "type": "options",
      "default": "m.text",
      "description": "The type of message to send",
      "options": [
        {
          "name": "Emote",
          "value": "m.emote",
          "description": "Perform an action (similar to /me in IRC)"
        },
        {
          "name": "Notice",
          "value": "m.notice",
          "description": "Send a notice"
        },
        {
          "name": "Text",
          "value": "m.text",
          "description": "Send a text message"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "Message Format",
      "name": "messageFormat",
      "type": "options",
      "default": "plain",
      "description": "The format of the message's body",
      "options": [
        {
          "name": "Plain Text",
          "value": "plain",
          "description": "Text only"
        },
        {
          "name": "HTML",
          "value": "org.matrix.custom.html",
          "description": "HTML-formatted text"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "Fallback Text",
      "name": "fallbackText",
      "type": "string",
      "default": "",
      "description": "A plain text message to display in case the HTML cannot be rendered by the Matrix client",
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "create"
          ],
          "messageFormat": [
            "org.matrix.custom.html"
          ]
        }
      }
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "type": "options",
      "default": "",
      "description": "The token to start returning events from. This token can be obtained from a prev_batch token returned for each room by the sync API. 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": [
            "message"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Other Options",
      "name": "otherOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Filter",
          "name": "filter",
          "type": "string",
          "default": "",
          "description": "A JSON RoomEventFilter to filter returned events with. More information can be found on this <a href=\"https://matrix.org/docs/spec/client_server/r0.6.0\">page</a>.",
          "placeholder": "{\"contains_url\":true,\"types\":[\"m.room.message\", \"m.sticker\"]}"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "New chat room with defined settings",
          "action": "Create a room"
        },
        {
          "name": "Invite",
          "value": "invite",
          "description": "Invite a user to a room",
          "action": "Invite a room"
        },
        {
          "name": "Join",
          "value": "join",
          "description": "Join a new room",
          "action": "Join a room"
        },
        {
          "name": "Kick",
          "value": "kick",
          "description": "Kick a user from a room",
          "action": "Kick a user from a room"
        },
        {
          "name": "Leave",
          "value": "leave",
          "description": "Leave a room",
          "action": "Leave a room"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room Name",
      "name": "roomName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Preset",
      "name": "preset",
      "type": "options",
      "default": "public_chat",
      "options": [
        {
          "name": "Private Chat",
          "value": "private_chat"
        },
        {
          "name": "Public Chat",
          "value": "public_chat",
          "description": "Open and public chat"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Room Alias",
      "name": "roomAlias",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Room ID or Alias",
      "name": "roomIdOrAlias",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "join"
          ]
        }
      }
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "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": [
            "room"
          ],
          "operation": [
            "leave"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "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": [
            "room"
          ],
          "operation": [
            "invite"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "The fully qualified user ID of the invitee",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "invite"
          ]
        }
      }
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "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": [
            "room"
          ],
          "operation": [
            "kick"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "The fully qualified user ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "kick"
          ]
        }
      }
    },
    {
      "displayName": "Reason",
      "name": "reason",
      "type": "string",
      "default": "",
      "description": "Reason for kick",
      "displayOptions": {
        "show": {
          "resource": [
            "room"
          ],
          "operation": [
            "kick"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many members",
          "action": "Get many room members"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "roomMember"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Room Name or ID",
      "name": "roomId",
      "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": [
            "roomMember"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "description": "Filtering options",
      "options": [
        {
          "displayName": "Exclude Membership",
          "name": "notMembership",
          "type": "options",
          "default": "",
          "description": "Excludes members whose membership is other than selected (uses OR filter with membership)",
          "options": [
            {
              "name": "Any",
              "value": "",
              "description": "Any user membership"
            },
            {
              "name": "Ban",
              "value": "ban",
              "description": "Users removed from the room"
            },
            {
              "name": "Invite",
              "value": "invite",
              "description": "Users invited to join"
            },
            {
              "name": "Join",
              "value": "join",
              "description": "Users currently in the room"
            },
            {
              "name": "Leave",
              "value": "leave",
              "description": "Users who left"
            }
          ]
        },
        {
          "displayName": "Membership",
          "name": "membership",
          "type": "options",
          "default": "",
          "description": "Only fetch users with selected membership status (uses OR filter with exclude membership)",
          "options": [
            {
              "name": "Any",
              "value": "",
              "description": "Any user membership"
            },
            {
              "name": "Ban",
              "value": "ban",
              "description": "Users removed from the room"
            },
            {
              "name": "Invite",
              "value": "invite",
              "description": "Users invited to join"
            },
            {
              "name": "Join",
              "value": "join",
              "description": "Users currently in the room"
            },
            {
              "name": "Leave",
              "value": "leave",
              "description": "Users who left"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "roomMember"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "me",
      "name": "Me",
      "description": "Get current user's account information",
      "resource": "account"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get single event by ID",
      "resource": "event"
    },
    {
      "operation": "upload",
      "name": "Upload",
      "description": "Send media to a chat room",
      "resource": "media"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Send a message to a room",
      "resource": "message"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many messages from a room",
      "resource": "message"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "New chat room with defined settings",
      "resource": "room"
    },
    {
      "operation": "invite",
      "name": "Invite",
      "description": "Invite a user to a room",
      "resource": "room"
    },
    {
      "operation": "join",
      "name": "Join",
      "description": "Join a new room",
      "resource": "room"
    },
    {
      "operation": "kick",
      "name": "Kick",
      "description": "Kick a user from a room",
      "resource": "room"
    },
    {
      "operation": "leave",
      "name": "Leave",
      "description": "Leave a room",
      "resource": "room"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many members",
      "resource": "roomMember"
    }
  ]


node_type: nodes-base.mattermost
package_name: n8n-nodes-base
display_name: Mattermost
description: Sends data to Mattermost
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "mattermostApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mattermost node documentation
  description: Learn how to use the Mattermost node in n8n. Follow technical documentation to integrate Mattermost node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Mattermost node

  Use the Mattermost node to automate work in Mattermost, and integrate Mattermost with other applications. n8n has built-in support for a wide range of Mattermost features, including creating, deleting, and getting channels, and users, as well as posting messages, and adding reactions.

  On this page, you'll find a list of operations the Mattermost node supports and links to more resources.

  /// note | Credentials
  Refer to [Mattermost credentials](/integrations/builtin/credentials/mattermost.md) for guidance on setting up authentication. 
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  * Channel
      * Add a user to a channel
      * Create a new channel
      * Soft delete a channel
      * Get a page of members for a channel
      * Restores a soft deleted channel
      * Search for a channel
      * Get statistics for a channel
  * Message
      * Soft delete a post, by marking the post as deleted in the database
      * Post a message into a channel
      * Post an ephemeral message into a channel
  * Reaction
      * Add a reaction to a post.
      * Remove a reaction from a post
      * Get all the reactions to one or more posts
  * User
      * Create a new user
      * Deactivates the user and revokes all its sessions by archiving its user object.
      * Retrieve all users
      * Get a user by email
      * Get a user by ID
      * Invite user to team


  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mattermost') ]]

  ## Related resources

  Refer to [Mattermost's documentation](https://api.mattermost.com/){:target=_blank .external-link} for more information about the service.

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

  ## Channel ID field error

  If you're not the System Administrator, you might get an error: **there was a problem loading the parameter options from server: "Mattermost error response: You do not have the appropriate permissions.** next to the **Channel ID** field.

  Ask your system administrator to grant you the `post:channel` permission.

  ## Find the channel ID

  To find the channel ID in Mattermost:

  1. Select the channel from the left sidebar.
  2. Select the channel name at the top.
  3. Select **View Info**.

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "message",
      "options": [
        {
          "name": "Channel",
          "value": "channel"
        },
        {
          "name": "Message",
          "value": "message"
        },
        {
          "name": "Reaction",
          "value": "reaction"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Add User",
          "value": "addUser",
          "description": "Add a user to a channel",
          "action": "Add a user to a channel"
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new channel",
          "action": "Create a channel"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Soft delete a channel",
          "action": "Delete a channel"
        },
        {
          "name": "Member",
          "value": "members",
          "description": "Get a page of members for a channel",
          "action": "Get a page of members for a channel"
        },
        {
          "name": "Restore",
          "value": "restore",
          "description": "Restores a soft deleted channel",
          "action": "Restore a soft-deleted channel"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search for a channel",
          "action": "Search for a channel"
        },
        {
          "name": "Statistics",
          "value": "statistics",
          "description": "Get statistics for a channel",
          "action": "Get statistics for a channel"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Team Name or ID",
      "name": "teamId",
      "type": "options",
      "default": "",
      "description": "The Mattermost Team. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams"
      }
    },
    {
      "displayName": "Display Name",
      "name": "displayName",
      "type": "string",
      "default": "",
      "description": "The non-unique UI name for the channel",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "channel",
      "type": "string",
      "default": "",
      "description": "The unique handle for the channel, will be present in the channel URL",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "public",
      "description": "The type of channel to create",
      "options": [
        {
          "name": "Private",
          "value": "private"
        },
        {
          "name": "Public",
          "value": "public"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Channel Name or ID",
      "name": "channelId",
      "type": "options",
      "default": "",
      "description": "The ID of the channel to soft delete. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Team Name or ID",
      "name": "teamId",
      "type": "options",
      "default": "",
      "description": "The Mattermost Team. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "members"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams"
      }
    },
    {
      "displayName": "Channel Name or ID",
      "name": "channelId",
      "type": "options",
      "default": "",
      "description": "The Mattermost Team. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "members"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannelsInTeam",
        "loadOptionsDependsOn": [
          "teamId"
        ]
      }
    },
    {
      "displayName": "Resolve Data",
      "name": "resolveData",
      "type": "boolean",
      "default": true,
      "description": "By default the response only contain the ID of the user. If this option gets activated, it will resolve the user automatically.",
      "displayOptions": {
        "show": {
          "resource": [
            "channel"
          ],
          "operation": [
            "members"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": true,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "members"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "members"
          ],
          "resource": [
            "channel"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Channel ID",
      "name": "channelId",
      "type": "string",
      "default": "",
      "description": "The ID of the channel to restore",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "restore"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Channel Name or ID",
      "name": "channelId",
      "type": "options",
      "default": "",
      "description": "The ID of the channel to invite user to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "addUser"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "User Name or ID",
      "name": "userId",
      "type": "options",
      "default": "",
      "description": "The ID of the user to invite into channel. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "addUser"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "Channel Name or ID",
      "name": "channelId",
      "type": "options",
      "default": "",
      "description": "The ID of the channel to get the statistics from. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "statistics"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Team Name or ID",
      "name": "teamId",
      "type": "options",
      "default": "",
      "description": "The Mattermost Team. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "channel"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams"
      }
    },
    {
      "displayName": "Search Term",
      "name": "term",
      "type": "string",
      "default": "",
      "description": "The search term for Channels in a Team",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "channel"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "channel"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "post",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Soft delete a post, by marking the post as deleted in the database",
          "action": "Delete a message"
        },
        {
          "name": "Post",
          "value": "post",
          "description": "Post a message into a channel",
          "action": "Post a message"
        },
        {
          "name": "Post Ephemeral",
          "value": "postEphemeral",
          "description": "Post an ephemeral message into a channel",
          "action": "Post an ephemeral message"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "message"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Channel Name or ID",
      "name": "channelId",
      "type": "options",
      "default": "",
      "description": "The ID of the channel to post to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "post"
          ],
          "resource": [
            "message"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "The text to send",
      "displayOptions": {
        "show": {
          "operation": [
            "post"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachments",
      "type": "collection",
      "default": {},
      "description": "The attachment to add",
      "options": [
        {
          "displayName": "Actions",
          "name": "actions",
          "placeholder": "Add Actions",
          "description": "Actions to add to message. More information can be found <a href=\"https://docs.mattermost.com/developer/interactive-messages.html\" target=\"_blank\">here</a>.",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Item",
              "name": "item",
              "values": [
                {
                  "displayName": "Type",
                  "name": "type",
                  "type": "options",
                  "options": [
                    {
                      "name": "Button",
                      "value": "button"
                    },
                    {
                      "name": "Select",
                      "value": "select"
                    }
                  ],
                  "default": "button",
                  "description": "The type of the action"
                },
                {
                  "displayName": "Data Source",
                  "name": "data_source",
                  "type": "options",
                  "displayOptions": {
                    "show": {
                      "type": [
                        "select"
                      ]
                    }
                  },
                  "options": [
                    {
                      "name": "Channels",
                      "value": "channels"
                    },
                    {
                      "name": "Custom",
                      "value": "custom"
                    },
                    {
                      "name": "Users",
                      "value": "users"
                    }
                  ],
                  "default": "custom",
                  "description": "The type of the action"
                },
                {
                  "displayName": "Options",
                  "name": "options",
                  "placeholder": "Add option",
                  "description": "Adds a new option to select field",
                  "type": "fixedCollection",
                  "typeOptions": {
                    "multipleValues": true
                  },
                  "displayOptions": {
                    "show": {
                      "data_source": [
                        "custom"
                      ],
                      "type": [
                        "select"
                      ]
                    }
                  },
                  "default": {},
                  "options": [
                    {
                      "name": "option",
                      "displayName": "Option",
                      "default": {},
                      "values": [
                        {
                          "displayName": "Option Text",
                          "name": "text",
                          "type": "string",
                          "default": "",
                          "description": "Text of the option"
                        },
                        {
                          "displayName": "Option Value",
                          "name": "value",
                          "type": "string",
                          "default": "",
                          "description": "Value of the option"
                        }
                      ]
                    }
                  ]
                },
                {
                  "displayName": "Name",
                  "name": "name",
                  "type": "string",
                  "default": "",
                  "description": "Name of the Action"
                },
                {
                  "displayName": "Integration",
                  "name": "integration",
                  "placeholder": "Add Integration",
                  "description": "Integration to add to message",
                  "type": "fixedCollection",
                  "typeOptions": {
                    "multipleValues": false
                  },
                  "default": {},
                  "options": [
                    {
                      "displayName": "Item",
                      "name": "item",
                      "default": {},
                      "values": [
                        {
                          "displayName": "URL",
                          "name": "url",
                          "type": "string",
                          "default": "",
                          "description": "URL of the Integration"
                        },
                        {
                          "displayName": "Context",
                          "name": "context",
                          "placeholder": "Add Context to Integration",
                          "description": "Adds a Context values set",
                          "type": "fixedCollection",
                          "typeOptions": {
                            "multipleValues": true
                          },
                          "default": {},
                          "options": [
                            {
                              "name": "property",
                              "displayName": "Property",
                              "default": {},
                              "values": [
                                {
                                  "displayName": "Property Name",
                                  "name": "name",
                                  "type": "string",
                                  "default": "",
                                  "description": "Name of the property to set"
                                },
                                {
                                  "displayName": "Property Value",
                                  "name": "value",
                                  "type": "string",
                                  "default": "",
                                  "description": "Value of the property to set"
                                }
                              ]
                            }
                          ]
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "displayName": "Author Icon",
          "name": "author_icon",
          "type": "string",
          "default": "",
          "description": "Icon which should appear for the user"
        },
        {
          "displayName": "Author Link",
          "name": "author_link",
          "type": "string",
          "default": "",
          "description": "Link for the author"
        },
        {
          "displayName": "Author Name",
          "name": "author_name",
          "type": "string",
          "default": "",
          "description": "Name that should appear"
        },
        {
          "displayName": "Color",
          "name": "color",
          "type": "color",
          "default": "#ff0000",
          "description": "Color of the line left of text"
        },
        {
          "displayName": "Fallback Text",
          "name": "fallback",
          "type": "string",
          "default": "",
          "description": "Required plain-text summary of the attachment"
        },
        {
          "displayName": "Fields",
          "name": "fields",
          "placeholder": "Add Fields",
          "description": "Fields to add to message",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "item",
              "displayName": "Item",
              "values": [
                {
                  "displayName": "Title",
                  "name": "title",
                  "type": "string",
                  "default": "",
                  "description": "Title of the item"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value of the item"
                },
                {
                  "displayName": "Short",
                  "name": "short",
                  "type": "boolean",
                  "default": true,
                  "description": "Whether items can be displayed next to each other"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Footer",
          "name": "footer",
          "type": "string",
          "default": "",
          "description": "Text of footer to add"
        },
        {
          "displayName": "Footer Icon",
          "name": "footer_icon",
          "type": "string",
          "default": "",
          "description": "Icon which should appear next to footer"
        },
        {
          "displayName": "Image URL",
          "name": "image_url",
          "type": "string",
          "default": "",
          "description": "URL of image"
        },
        {
          "displayName": "Pretext",
          "name": "pretext",
          "type": "string",
          "default": "",
          "description": "Text which appears before the message block"
        },
        {
          "displayName": "Text",
          "name": "text",
          "type": "string",
          "default": "",
          "description": "Text to send"
        },
        {
          "displayName": "Thumbnail URL",
          "name": "thumb_url",
          "type": "string",
          "default": "",
          "description": "URL of thumbnail"
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Title of the message"
        },
        {
          "displayName": "Title Link",
          "name": "title_link",
          "type": "string",
          "default": "",
          "description": "Link of the title"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "post"
          ],
          "resource": [
            "message"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "multipleValueButtonText": "Add attachment"
      }
    },
    {
      "displayName": "Other Options",
      "name": "otherOptions",
      "type": "collection",
      "default": {},
      "description": "Other options to set",
      "options": [
        {
          "displayName": "Parent Post ID",
          "name": "root_id",
          "type": "string",
          "default": "",
          "description": "If set, the created message will be a threaded reply to the specified parent post ID"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "post"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "User Name or ID",
      "name": "userId",
      "type": "options",
      "default": "",
      "description": "ID of the user to send the ephemeral message to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "postEphemeral"
          ],
          "resource": [
            "message"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "Channel Name or ID",
      "name": "channelId",
      "type": "options",
      "default": "",
      "description": "ID of the channel to send the ephemeral message in. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "postEphemeral"
          ],
          "resource": [
            "message"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getChannels"
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "Text to send in the ephemeral message",
      "displayOptions": {
        "show": {
          "operation": [
            "postEphemeral"
          ],
          "resource": [
            "message"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Add a reaction to a post",
          "action": "Create a reaction"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Remove a reaction from a post",
          "action": "Delete a reaction"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many reactions to one or more posts",
          "action": "Get many reactions"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User Name or ID",
      "name": "userId",
      "type": "options",
      "default": "",
      "description": "ID of the user sending the reaction. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post to react to. Obtainable from the post link: <code>https://mattermost.internal.n8n.io/[server]/pl/[postId]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Emoji Name",
      "name": "emojiName",
      "type": "string",
      "default": "",
      "description": "Emoji to use for this reaction",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "User Name or ID",
      "name": "userId",
      "type": "options",
      "default": "",
      "description": "ID of the user whose reaction to delete. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post whose reaction to delete. Obtainable from the post link: <code>https://mattermost.internal.n8n.io/[server]/pl/[postId]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Emoji Name",
      "name": "emojiName",
      "type": "string",
      "default": "",
      "description": "Name of the emoji to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "One or more (comma-separated) posts to retrieve reactions from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reaction"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": true,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "reaction"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "reaction"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new user",
          "action": "Create a user"
        },
        {
          "name": "Deactive",
          "value": "deactive",
          "description": "Deactivates the user and revokes all its sessions by archiving its user object",
          "action": "Deactivate a user"
        },
        {
          "name": "Get By Email",
          "value": "getByEmail",
          "description": "Get a user by email",
          "action": "Get a user by email"
        },
        {
          "name": "Get By ID",
          "value": "getById",
          "description": "Get a user by ID",
          "action": "Get a user by ID"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many users",
          "action": "Get many users"
        },
        {
          "name": "Invite",
          "value": "invite",
          "description": "Invite user to team",
          "action": "Invite a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Username",
      "name": "username",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Auth Service",
      "name": "authService",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "Gitlab",
          "value": "gitlab"
        },
        {
          "name": "Google",
          "value": "google"
        },
        {
          "name": "LDAP",
          "value": "ldap"
        },
        {
          "name": "Office365",
          "value": "office365"
        },
        {
          "name": "SAML",
          "value": "saml"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Auth Data",
      "name": "authData",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        },
        "hide": {
          "authService": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ],
          "authService": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Password",
      "name": "password",
      "type": "string",
      "default": "",
      "description": "The password used for email authentication",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ],
          "authService": [
            "email"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Locale",
          "name": "locale",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Nickname",
          "name": "nickname",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Notification Settings",
          "name": "notificationUi",
          "type": "fixedCollection",
          "placeholder": "Add Notification Setting",
          "default": {},
          "typeOptions": {
            "multipleValues": false
          },
          "options": [
            {
              "displayName": "Notify",
              "name": "notificationValues",
              "values": [
                {
                  "displayName": "Channel",
                  "name": "channel",
                  "type": "boolean",
                  "default": true,
                  "description": "Whether to enable channel-wide notifications (@channel, @all, etc.), \"false\" to disable. Defaults to \"true\"."
                },
                {
                  "displayName": "Desktop",
                  "name": "desktop",
                  "type": "options",
                  "options": [
                    {
                      "name": "All",
                      "value": "all",
                      "description": "Notifications for all activity"
                    },
                    {
                      "name": "Mention",
                      "value": "mention",
                      "description": "Mentions and direct messages only"
                    },
                    {
                      "name": "None",
                      "value": "none",
                      "description": "Mentions and direct messages only"
                    }
                  ],
                  "default": "all"
                },
                {
                  "displayName": "Desktop Sound",
                  "name": "desktop_sound",
                  "type": "boolean",
                  "default": true,
                  "description": "Whether to enable sound on desktop notifications, \"false\" to disable. Defaults to \"true\"."
                },
                {
                  "displayName": "Email",
                  "name": "email",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether to enable email notifications, \"false\" to disable. Defaults to \"false\"."
                },
                {
                  "displayName": "First Name",
                  "name": "first_name",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether to enable mentions for first name. Defaults to \"true\" if a first name is set, \"false\" otherwise."
                },
                {
                  "displayName": "Mention Keys",
                  "name": "mention_keys",
                  "type": "string",
                  "default": "",
                  "description": "A comma-separated list of words to count as mentions. Defaults to username and @username."
                },
                {
                  "displayName": "Push",
                  "name": "push",
                  "type": "options",
                  "options": [
                    {
                      "name": "All",
                      "value": "all",
                      "description": "Notifications for all activity"
                    },
                    {
                      "name": "Mention",
                      "value": "mention",
                      "description": "Mentions and direct messages only"
                    },
                    {
                      "name": "None",
                      "value": "none",
                      "description": "Mentions and direct messages only"
                    }
                  ],
                  "default": "mention"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "User GUID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "deactive"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": true,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "In Channel",
          "name": "inChannel",
          "type": "string",
          "default": "",
          "description": "The ID of the channel to get users for"
        },
        {
          "displayName": "In Team",
          "name": "inTeam",
          "type": "string",
          "default": "",
          "description": "The ID of the team to get users for"
        },
        {
          "displayName": "Not In Team",
          "name": "notInTeam",
          "type": "string",
          "default": "",
          "description": "The ID of the team to exclude users for"
        },
        {
          "displayName": "Not In Channel",
          "name": "notInChannel",
          "type": "string",
          "default": "",
          "description": "The ID of the channel to exclude users for"
        },
        {
          "displayName": "Sort",
          "name": "sort",
          "type": "options",
          "options": [
            {
              "name": "Created At",
              "value": "createdAt"
            },
            {
              "name": "Last Activity At",
              "value": "lastActivityAt"
            },
            {
              "name": "Status",
              "value": "status"
            },
            {
              "name": "Username",
              "value": "username"
            }
          ],
          "default": "username",
          "description": "The ID of the channel to exclude users for"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "User's email",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getByEmail"
          ]
        }
      }
    },
    {
      "displayName": "User IDs",
      "name": "userIds",
      "type": "string",
      "default": "",
      "description": "User's ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getById"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Since",
          "name": "since",
          "type": "dateTime",
          "default": "",
          "description": "Only return users that have been modified since the given Unix timestamp (in milliseconds)"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getById"
          ]
        }
      }
    },
    {
      "displayName": "Team Name or ID",
      "name": "teamId",
      "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": [
            "user"
          ],
          "operation": [
            "invite"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTeams"
      }
    },
    {
      "displayName": "Emails",
      "name": "emails",
      "type": "string",
      "default": "",
      "description": "User's email. Multiple emails can be set separated by comma.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "invite"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "addUser",
      "name": "Add User",
      "description": "Add a user to a channel",
      "resource": "channel"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new channel",
      "resource": "channel"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Soft delete a channel",
      "resource": "channel"
    },
    {
      "operation": "members",
      "name": "Member",
      "description": "Get a page of members for a channel",
      "resource": "channel"
    },
    {
      "operation": "restore",
      "name": "Restore",
      "description": "Restores a soft deleted channel",
      "resource": "channel"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search for a channel",
      "resource": "channel"
    },
    {
      "operation": "statistics",
      "name": "Statistics",
      "description": "Get statistics for a channel",
      "resource": "channel"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Soft delete a post, by marking the post as deleted in the database",
      "resource": "message"
    },
    {
      "operation": "post",
      "name": "Post",
      "description": "Post a message into a channel",
      "resource": "message"
    },
    {
      "operation": "postEphemeral",
      "name": "Post Ephemeral",
      "description": "Post an ephemeral message into a channel",
      "resource": "message"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Add a reaction to a post",
      "resource": "reaction"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Remove a reaction from a post",
      "resource": "reaction"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many reactions to one or more posts",
      "resource": "reaction"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new user",
      "resource": "user"
    },
    {
      "operation": "deactive",
      "name": "Deactive",
      "description": "Deactivates the user and revokes all its sessions by archiving its user object",
      "resource": "user"
    },
    {
      "operation": "getByEmail",
      "name": "Get By Email",
      "description": "Get a user by email",
      "resource": "user"
    },
    {
      "operation": "getById",
      "name": "Get By ID",
      "description": "Get a user by ID",
      "resource": "user"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Retrieve many users",
      "resource": "user"
    },
    {
      "operation": "invite",
      "name": "Invite",
      "description": "Invite user to team",
      "resource": "user"
    }
  ]


node_type: nodes-base.mauticTool
package_name: n8n-nodes-base
display_name: Mautic Tool
description: Consume Mautic API (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 1
outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.mautic
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mautic node documentation
  description: Learn how to use the Mautic node in n8n. Follow technical documentation to integrate Mautic node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Mautic node

  Use the Mautic node to automate work in Mautic, and integrate Mautic with other applications. n8n has built-in support for a wide range of Mautic features, including creating, updating, deleting, and getting companies, and contacts, as well as adding and removing campaign contacts. 

  On this page, you'll find a list of operations the Mautic node supports and links to more resources.

  /// note | Credentials
  Refer to [Mautic credentials](/integrations/builtin/credentials/mautic.md) for guidance on setting up authentication. 
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  * Campaign Contact
      * Add contact to a campaign
      * Remove contact from a campaign
  * Company
      * Create a new company
      * Delete a company
      * Get data of a company
      * Get data of all companies
      * Update a company
  * Company Contact
      * Add contact to a company
      * Remove a contact from a company
  * Contact
      * Create a new contact
      * Delete a contact
      * Edit contact's points
      * Add/remove contacts from/to the don't contact list
      * Get data of a contact
      * Get data of all contacts
      * Send email to contact
      * Update a contact
  * Contact Segment
      * Add contact to a segment
      * Remove contact from a segment
  * Segment Email
      * Send

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mautic') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Mautic"
    },
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "credentials",
      "options": [
        {
          "name": "Credentials",
          "value": "credentials"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "contact",
      "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"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new company",
          "action": "Create a company"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a company",
          "action": "Delete a company"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a company",
          "action": "Get a company"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many companies",
          "action": "Get many companies"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a company",
          "action": "Update a company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Company Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the company to create",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "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"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addressUi",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "addressValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Address Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Address Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Zip Code",
                  "name": "zipCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Annual Revenue",
          "name": "annualRevenue",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Company Email",
          "name": "companyEmail",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Fields",
          "description": "Adds a custom fields to set also values which have not been predefined",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCompanyFields"
                  },
                  "default": "",
                  "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field to set"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Fax",
          "name": "fax",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Industry Name or ID",
          "name": "industry",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getIndustries"
          },
          "default": ""
        },
        {
          "displayName": "Is Published",
          "name": "isPublished",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Number of Employees",
          "name": "numberOfEmpoyees",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Overwrite With Blank",
          "name": "overwriteWithBlank",
          "type": "boolean",
          "default": false,
          "description": "Whether empty values are set to fields. Otherwise empty values are skipped."
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "companyId",
      "type": "string",
      "default": "",
      "description": "The ID of the company to update",
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "company"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addressUi",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "addressValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Address Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Address Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Zip Code",
                  "name": "zipCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Annual Revenue",
          "name": "annualRevenue",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Company Email",
          "name": "companyEmail",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Company Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Fields",
          "description": "Adds a custom fields to set also values which have not been predefined",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCompanyFields"
                  },
                  "default": "",
                  "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field to set"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Fax",
          "name": "fax",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Industry Name or ID",
          "name": "industry",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getIndustries"
          },
          "default": ""
        },
        {
          "displayName": "Is Published",
          "name": "isPublished",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Number of Employees",
          "name": "numberOfEmpoyees",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Overwrite With Blank",
          "name": "overwriteWithBlank",
          "type": "boolean",
          "default": false,
          "description": "Whether empty values are set to fields. Otherwise, empty values are skipped."
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "companyId",
      "type": "string",
      "default": "",
      "description": "The ID of the company to return",
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "company"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 30,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 30
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Order Direction",
          "name": "orderByDir",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "",
          "description": "Sort direction: asc or desc"
        },
        {
          "displayName": "Order By Name or ID",
          "name": "orderBy",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyFields"
          },
          "default": "",
          "description": "Column to sort by. Can use any column listed in the response. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Search",
          "name": "search",
          "type": "string",
          "default": "",
          "description": "String or search command to filter entities by"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "companyId",
      "type": "string",
      "default": "",
      "description": "The ID of the company to delete",
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "company"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new contact",
          "action": "Create a contact"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a contact",
          "action": "Delete a contact"
        },
        {
          "name": "Edit Contact Points",
          "value": "editContactPoint",
          "description": "Edit contact's points",
          "action": "Edit a contact's points"
        },
        {
          "name": "Edit Do Not Contact List",
          "value": "editDoNotContactList",
          "description": "Add/remove contacts from/to the do not contact list",
          "action": "Add/remove contacts from/to the do not contact list"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a contact",
          "action": "Get a contact"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many contacts",
          "action": "Get many contacts"
        },
        {
          "name": "Send Email",
          "value": "sendEmail",
          "description": "Send email to contact",
          "action": "Send email to a contact"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a contact",
          "action": "Update a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the contact",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastName",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Primary Company Name or ID",
      "name": "company",
      "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
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCompanies"
      }
    },
    {
      "displayName": "Position",
      "name": "position",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Body",
      "name": "bodyJson",
      "type": "json",
      "default": "",
      "description": "Contact parameters",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "contact"
          ],
          "jsonParameters": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addressUi",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "addressValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Address Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Address Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Zip Code",
                  "name": "zipCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "B2B or B2C",
          "name": "b2bOrb2c",
          "type": "options",
          "options": [
            {
              "name": "B2B",
              "value": "B2B"
            },
            {
              "name": "B2C",
              "value": "B2C"
            }
          ],
          "default": ""
        },
        {
          "displayName": "CRM ID",
          "name": "crmId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Fields",
          "description": "Adds a custom fields to set also values which have not been predefined",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getContactFields"
                  },
                  "default": "",
                  "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field to set"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Fax",
          "name": "fax",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Has Purchased",
          "name": "hasPurchased",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "IP Address",
          "name": "ipAddress",
          "type": "string",
          "default": "",
          "description": "IP address to associate with the contact"
        },
        {
          "displayName": "Last Active",
          "name": "lastActive",
          "type": "dateTime",
          "default": "",
          "description": "Date/time in UTC;"
        },
        {
          "displayName": "Mobile",
          "name": "mobile",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Owner ID",
          "name": "ownerId",
          "type": "string",
          "default": "",
          "description": "ID of a Mautic user to assign this contact to"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Prospect or Customer",
          "name": "prospectOrCustomer",
          "type": "options",
          "options": [
            {
              "name": "Prospect",
              "value": "Prospect"
            },
            {
              "name": "Customer",
              "value": "Customer"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Sandbox",
          "name": "sandbox",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Stage Name or ID",
          "name": "stage",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getStages"
          },
          "default": ""
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": []
        },
        {
          "displayName": "Social Media",
          "name": "socialMediaUi",
          "placeholder": "Social Media",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "socialMediaValues",
              "displayName": "Social Media",
              "values": [
                {
                  "displayName": "Facebook",
                  "name": "facebook",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Foursquare",
                  "name": "foursquare",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Instagram",
                  "name": "instagram",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "LinkedIn",
                  "name": "linkedIn",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Skype",
                  "name": "skype",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Twitter",
                  "name": "twitter",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Body",
          "name": "bodyJson",
          "type": "json",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                true
              ]
            }
          },
          "default": "",
          "description": "Contact parameters"
        },
        {
          "displayName": "Address",
          "name": "addressUi",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": {},
          "options": [
            {
              "name": "addressValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Address Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Address Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Zip Code",
                  "name": "zipCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "B2B or B2C",
          "name": "b2bOrb2c",
          "type": "options",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "options": [
            {
              "name": "B2B",
              "value": "B2B"
            },
            {
              "name": "B2C",
              "value": "B2C"
            }
          ],
          "default": ""
        },
        {
          "displayName": "CRM ID",
          "name": "crmId",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Fields",
          "description": "Adds a custom fields to set also values which have not been predefined",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getContactFields"
                  },
                  "default": "",
                  "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field to set"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": "",
          "description": "Email address of the contact"
        },
        {
          "displayName": "Fax",
          "name": "fax",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Has Purchased",
          "name": "hasPurchased",
          "type": "boolean",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": false
        },
        {
          "displayName": "IP Address",
          "name": "ipAddress",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": "",
          "description": "IP address to associate with the contact"
        },
        {
          "displayName": "Last Active",
          "name": "lastActive",
          "type": "dateTime",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": "",
          "description": "Date/time in UTC;"
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": "",
          "description": "LastName"
        },
        {
          "displayName": "Mobile",
          "name": "mobile",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Owner ID",
          "name": "ownerId",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": "",
          "description": "ID of a Mautic user to assign this contact to"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Position",
          "name": "position",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Primary Company Name or ID",
          "name": "company",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Prospect or Customer",
          "name": "prospectOrCustomer",
          "type": "options",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "options": [
            {
              "name": "Prospect",
              "value": "Prospect"
            },
            {
              "name": "Customer",
              "value": "Customer"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Sandbox",
          "name": "sandbox",
          "type": "boolean",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": false
        },
        {
          "displayName": "Stage Name or ID",
          "name": "stage",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "typeOptions": {
            "loadOptionsMethod": "getStages"
          },
          "default": ""
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": []
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Social Media",
          "name": "socialMediaUi",
          "placeholder": "Social Media",
          "type": "fixedCollection",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "socialMediaValues",
              "displayName": "Social Media",
              "values": [
                {
                  "displayName": "Facebook",
                  "name": "facebook",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Foursquare",
                  "name": "foursquare",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Instagram",
                  "name": "instagram",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "LinkedIn",
                  "name": "linkedIn",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Skype",
                  "name": "skype",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Twitter",
                  "name": "twitter",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "IP Address",
          "name": "ipAddress",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": "",
          "description": "IP address to associate with the contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "editDoNotContactList"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Action",
      "name": "action",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "action": "Add a contact"
        },
        {
          "name": "Remove",
          "value": "remove",
          "action": "Remove a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "editDoNotContactList"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Channel",
      "name": "channel",
      "type": "options",
      "default": "email",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "SMS",
          "value": "sms"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "editDoNotContactList"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Reason To Do Not Contact",
          "name": "reason",
          "type": "options",
          "options": [
            {
              "name": "Unsubscribed",
              "value": "1"
            },
            {
              "name": "Bounced",
              "value": "2"
            },
            {
              "name": "Manual",
              "value": "3"
            }
          ],
          "default": "3"
        },
        {
          "displayName": "Comments",
          "name": "comments",
          "type": "string",
          "default": "",
          "description": "A text describing details of Do Not Contact entry"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "editDoNotContactList"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "editContactPoint"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Action",
      "name": "action",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "action": "Add a contact"
        },
        {
          "name": "Remove",
          "value": "remove",
          "action": "Remove a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "editContactPoint"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Points",
      "name": "points",
      "type": "number",
      "default": 0,
      "displayOptions": {
        "show": {
          "operation": [
            "editContactPoint"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 30,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 30
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Search",
          "name": "search",
          "type": "string",
          "displayOptions": {
            "show": {
              "/resource": [
                "contact"
              ],
              "/operation": [
                "getAll"
              ]
            }
          },
          "default": "",
          "description": "String or search command to filter entities by"
        },
        {
          "displayName": "Order By",
          "name": "orderBy",
          "type": "string",
          "displayOptions": {
            "show": {
              "/resource": [
                "contact"
              ],
              "/operation": [
                "getAll"
              ]
            }
          },
          "default": "",
          "description": "Column to sort by. Can use any column listed in the response."
        },
        {
          "displayName": "Order By Dir",
          "name": "orderByDir",
          "type": "options",
          "displayOptions": {
            "show": {
              "/resource": [
                "contact"
              ],
              "/operation": [
                "getAll"
              ]
            }
          },
          "default": "",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "description": "Sort direction: ASC or DESC"
        },
        {
          "displayName": "Published Only",
          "name": "publishedOnly",
          "type": "boolean",
          "displayOptions": {
            "show": {
              "/resource": [
                "contact"
              ],
              "/operation": [
                "getAll"
              ]
            }
          },
          "default": false,
          "description": "Whether to return currently published entities"
        },
        {
          "displayName": "Minimal",
          "name": "minimal",
          "type": "boolean",
          "displayOptions": {
            "show": {
              "/resource": [
                "contact"
              ],
              "/operation": [
                "getAll"
              ]
            }
          },
          "default": false,
          "description": "Whether to return array of entities without additional lists in it"
        },
        {
          "displayName": "RAW Data",
          "name": "rawData",
          "type": "boolean",
          "default": true,
          "description": "By default only the data of the fields get returned. If this options gets set the RAW response with all data gets returned."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        },
        "hide": {
          "operation": [
            "sendEmail",
            "editDoNotContactList",
            "editContactPoint"
          ]
        }
      }
    },
    {
      "displayName": "Campaign Email Name or ID",
      "name": "campaignEmailId",
      "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"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCampaignEmails"
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "sendEmail"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add contact to a segment",
          "action": "Add a contact to a segment"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove contact from a segment",
          "action": "Remove a contact from a segment"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contactSegment"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactSegment"
          ],
          "operation": [
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Segment Name or ID",
      "name": "segmentId",
      "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"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSegments"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add contact to a campaign",
          "action": "Add a campaign contact"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove contact from a campaign",
          "action": "Remove a campaign contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "campaignContact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "campaignContact"
          ],
          "operation": [
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Campaign Name or ID",
      "name": "campaignId",
      "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"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCampaigns"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add contact to a company",
          "action": "Add a company contact"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a contact from a company",
          "action": "Remove a company contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "companyContact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "The ID of the contact",
      "displayOptions": {
        "show": {
          "resource": [
            "companyContact"
          ],
          "operation": [
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "companyId",
      "type": "string",
      "default": "",
      "description": "The ID of the company",
      "displayOptions": {
        "show": {
          "resource": [
            "companyContact"
          ],
          "operation": [
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "action": "Send an email to a segment"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "segmentEmail"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Segment Email Name or ID",
      "name": "segmentEmailId",
      "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"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSegmentEmails"
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new company",
      "resource": "company"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a company",
      "resource": "company"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get data of a company",
      "resource": "company"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get data of many companies",
      "resource": "company"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a company",
      "resource": "company"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new contact",
      "resource": "contact"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a contact",
      "resource": "contact"
    },
    {
      "operation": "editContactPoint",
      "name": "Edit Contact Points",
      "description": "Edit contact's points",
      "resource": "contact"
    },
    {
      "operation": "editDoNotContactList",
      "name": "Edit Do Not Contact List",
      "description": "Add/remove contacts from/to the do not contact list",
      "resource": "contact"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get data of a contact",
      "resource": "contact"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get data of many contacts",
      "resource": "contact"
    },
    {
      "operation": "sendEmail",
      "name": "Send Email",
      "description": "Send email to contact",
      "resource": "contact"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a contact",
      "resource": "contact"
    },
    {
      "operation": "add",
      "name": "Add",
      "resource": "contact"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "resource": "contact"
    },
    {
      "operation": "add",
      "name": "Add",
      "resource": "contact"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "resource": "contact"
    },
    {
      "operation": "add",
      "name": "Add",
      "description": "Add contact to a segment",
      "resource": "contactSegment"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "description": "Remove contact from a segment",
      "resource": "contactSegment"
    },
    {
      "operation": "add",
      "name": "Add",
      "description": "Add contact to a campaign",
      "resource": "campaignContact"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "description": "Remove contact from a campaign",
      "resource": "campaignContact"
    },
    {
      "operation": "add",
      "name": "Add",
      "description": "Add contact to a company",
      "resource": "companyContact"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "description": "Remove a contact from a company",
      "resource": "companyContact"
    },
    {
      "operation": "send",
      "name": "Send",
      "resource": "segmentEmail"
    }
  ]

credentials_required:
  [
    {
      "name": "mauticApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "credentials"
          ]
        }
      }
    },
    {
      "name": "mauticOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


node_type: nodes-base.mautic
package_name: n8n-nodes-base
display_name: Mautic
description: Consume Mautic API
category: output
development_style: programmatic
version: 1
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mautic node documentation
  description: Learn how to use the Mautic node in n8n. Follow technical documentation to integrate Mautic node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Mautic node

  Use the Mautic node to automate work in Mautic, and integrate Mautic with other applications. n8n has built-in support for a wide range of Mautic features, including creating, updating, deleting, and getting companies, and contacts, as well as adding and removing campaign contacts. 

  On this page, you'll find a list of operations the Mautic node supports and links to more resources.

  /// note | Credentials
  Refer to [Mautic credentials](/integrations/builtin/credentials/mautic.md) for guidance on setting up authentication. 
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  * Campaign Contact
      * Add contact to a campaign
      * Remove contact from a campaign
  * Company
      * Create a new company
      * Delete a company
      * Get data of a company
      * Get data of all companies
      * Update a company
  * Company Contact
      * Add contact to a company
      * Remove a contact from a company
  * Contact
      * Create a new contact
      * Delete a contact
      * Edit contact's points
      * Add/remove contacts from/to the don't contact list
      * Get data of a contact
      * Get data of all contacts
      * Send email to contact
      * Update a contact
  * Contact Segment
      * Add contact to a segment
      * Remove contact from a segment
  * Segment Email
      * Send

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'mautic') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "credentials",
      "options": [
        {
          "name": "Credentials",
          "value": "credentials"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "contact",
      "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"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new company",
          "action": "Create a company"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a company",
          "action": "Delete a company"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a company",
          "action": "Get a company"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many companies",
          "action": "Get many companies"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a company",
          "action": "Update a company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Company Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the company to create",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "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"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addressUi",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "addressValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Address Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Address Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Zip Code",
                  "name": "zipCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Annual Revenue",
          "name": "annualRevenue",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Company Email",
          "name": "companyEmail",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Fields",
          "description": "Adds a custom fields to set also values which have not been predefined",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCompanyFields"
                  },
                  "default": "",
                  "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field to set"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Fax",
          "name": "fax",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Industry Name or ID",
          "name": "industry",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getIndustries"
          },
          "default": ""
        },
        {
          "displayName": "Is Published",
          "name": "isPublished",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Number of Employees",
          "name": "numberOfEmpoyees",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Overwrite With Blank",
          "name": "overwriteWithBlank",
          "type": "boolean",
          "default": false,
          "description": "Whether empty values are set to fields. Otherwise empty values are skipped."
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "companyId",
      "type": "string",
      "default": "",
      "description": "The ID of the company to update",
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "company"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addressUi",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "addressValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Address Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Address Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Zip Code",
                  "name": "zipCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Annual Revenue",
          "name": "annualRevenue",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Company Email",
          "name": "companyEmail",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Company Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Fields",
          "description": "Adds a custom fields to set also values which have not been predefined",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCompanyFields"
                  },
                  "default": "",
                  "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field to set"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Fax",
          "name": "fax",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Industry Name or ID",
          "name": "industry",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getIndustries"
          },
          "default": ""
        },
        {
          "displayName": "Is Published",
          "name": "isPublished",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Number of Employees",
          "name": "numberOfEmpoyees",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Overwrite With Blank",
          "name": "overwriteWithBlank",
          "type": "boolean",
          "default": false,
          "description": "Whether empty values are set to fields. Otherwise, empty values are skipped."
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "companyId",
      "type": "string",
      "default": "",
      "description": "The ID of the company to return",
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "company"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 30,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 30
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Order Direction",
          "name": "orderByDir",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "",
          "description": "Sort direction: asc or desc"
        },
        {
          "displayName": "Order By Name or ID",
          "name": "orderBy",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyFields"
          },
          "default": "",
          "description": "Column to sort by. Can use any column listed in the response. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Search",
          "name": "search",
          "type": "string",
          "default": "",
          "description": "String or search command to filter entities by"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "companyId",
      "type": "string",
      "default": "",
      "description": "The ID of the company to delete",
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "company"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new contact",
          "action": "Create a contact"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a contact",
          "action": "Delete a contact"
        },
        {
          "name": "Edit Contact Points",
          "value": "editContactPoint",
          "description": "Edit contact's points",
          "action": "Edit a contact's points"
        },
        {
          "name": "Edit Do Not Contact List",
          "value": "editDoNotContactList",
          "description": "Add/remove contacts from/to the do not contact list",
          "action": "Add/remove contacts from/to the do not contact list"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a contact",
          "action": "Get a contact"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many contacts",
          "action": "Get many contacts"
        },
        {
          "name": "Send Email",
          "value": "sendEmail",
          "description": "Send email to contact",
          "action": "Send email to a contact"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a contact",
          "action": "Update a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email address of the contact",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastName",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Primary Company Name or ID",
      "name": "company",
      "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
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCompanies"
      }
    },
    {
      "displayName": "Position",
      "name": "position",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Body",
      "name": "bodyJson",
      "type": "json",
      "default": "",
      "description": "Contact parameters",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "contact"
          ],
          "jsonParameters": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addressUi",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "addressValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Address Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Address Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Zip Code",
                  "name": "zipCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "B2B or B2C",
          "name": "b2bOrb2c",
          "type": "options",
          "options": [
            {
              "name": "B2B",
              "value": "B2B"
            },
            {
              "name": "B2C",
              "value": "B2C"
            }
          ],
          "default": ""
        },
        {
          "displayName": "CRM ID",
          "name": "crmId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Fields",
          "description": "Adds a custom fields to set also values which have not been predefined",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getContactFields"
                  },
                  "default": "",
                  "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field to set"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Fax",
          "name": "fax",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Has Purchased",
          "name": "hasPurchased",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "IP Address",
          "name": "ipAddress",
          "type": "string",
          "default": "",
          "description": "IP address to associate with the contact"
        },
        {
          "displayName": "Last Active",
          "name": "lastActive",
          "type": "dateTime",
          "default": "",
          "description": "Date/time in UTC;"
        },
        {
          "displayName": "Mobile",
          "name": "mobile",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Owner ID",
          "name": "ownerId",
          "type": "string",
          "default": "",
          "description": "ID of a Mautic user to assign this contact to"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Prospect or Customer",
          "name": "prospectOrCustomer",
          "type": "options",
          "options": [
            {
              "name": "Prospect",
              "value": "Prospect"
            },
            {
              "name": "Customer",
              "value": "Customer"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Sandbox",
          "name": "sandbox",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Stage Name or ID",
          "name": "stage",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getStages"
          },
          "default": ""
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": []
        },
        {
          "displayName": "Social Media",
          "name": "socialMediaUi",
          "placeholder": "Social Media",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "socialMediaValues",
              "displayName": "Social Media",
              "values": [
                {
                  "displayName": "Facebook",
                  "name": "facebook",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Foursquare",
                  "name": "foursquare",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Instagram",
                  "name": "instagram",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "LinkedIn",
                  "name": "linkedIn",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Skype",
                  "name": "skype",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Twitter",
                  "name": "twitter",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Body",
          "name": "bodyJson",
          "type": "json",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                true
              ]
            }
          },
          "default": "",
          "description": "Contact parameters"
        },
        {
          "displayName": "Address",
          "name": "addressUi",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": {},
          "options": [
            {
              "name": "addressValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Address Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Address Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Zip Code",
                  "name": "zipCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "B2B or B2C",
          "name": "b2bOrb2c",
          "type": "options",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "options": [
            {
              "name": "B2B",
              "value": "B2B"
            },
            {
              "name": "B2C",
              "value": "B2C"
            }
          ],
          "default": ""
        },
        {
          "displayName": "CRM ID",
          "name": "crmId",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Fields",
          "description": "Adds a custom fields to set also values which have not been predefined",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getContactFields"
                  },
                  "default": "",
                  "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field to set"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": "",
          "description": "Email address of the contact"
        },
        {
          "displayName": "Fax",
          "name": "fax",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Has Purchased",
          "name": "hasPurchased",
          "type": "boolean",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": false
        },
        {
          "displayName": "IP Address",
          "name": "ipAddress",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": "",
          "description": "IP address to associate with the contact"
        },
        {
          "displayName": "Last Active",
          "name": "lastActive",
          "type": "dateTime",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": "",
          "description": "Date/time in UTC;"
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": "",
          "description": "LastName"
        },
        {
          "displayName": "Mobile",
          "name": "mobile",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Owner ID",
          "name": "ownerId",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": "",
          "description": "ID of a Mautic user to assign this contact to"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Position",
          "name": "position",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Primary Company Name or ID",
          "name": "company",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Prospect or Customer",
          "name": "prospectOrCustomer",
          "type": "options",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "options": [
            {
              "name": "Prospect",
              "value": "Prospect"
            },
            {
              "name": "Customer",
              "value": "Customer"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Sandbox",
          "name": "sandbox",
          "type": "boolean",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": false
        },
        {
          "displayName": "Stage Name or ID",
          "name": "stage",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "typeOptions": {
            "loadOptionsMethod": "getStages"
          },
          "default": ""
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": []
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Social Media",
          "name": "socialMediaUi",
          "placeholder": "Social Media",
          "type": "fixedCollection",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "socialMediaValues",
              "displayName": "Social Media",
              "values": [
                {
                  "displayName": "Facebook",
                  "name": "facebook",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Foursquare",
                  "name": "foursquare",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Instagram",
                  "name": "instagram",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "LinkedIn",
                  "name": "linkedIn",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Skype",
                  "name": "skype",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Twitter",
                  "name": "twitter",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "IP Address",
          "name": "ipAddress",
          "type": "string",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": "",
          "description": "IP address to associate with the contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "editDoNotContactList"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Action",
      "name": "action",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "action": "Add a contact"
        },
        {
          "name": "Remove",
          "value": "remove",
          "action": "Remove a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "editDoNotContactList"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Channel",
      "name": "channel",
      "type": "options",
      "default": "email",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "SMS",
          "value": "sms"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "editDoNotContactList"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Reason To Do Not Contact",
          "name": "reason",
          "type": "options",
          "options": [
            {
              "name": "Unsubscribed",
              "value": "1"
            },
            {
              "name": "Bounced",
              "value": "2"
            },
            {
              "name": "Manual",
              "value": "3"
            }
          ],
          "default": "3"
        },
        {
          "displayName": "Comments",
          "name": "comments",
          "type": "string",
          "default": "",
          "description": "A text describing details of Do Not Contact entry"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "editDoNotContactList"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "editContactPoint"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Action",
      "name": "action",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "action": "Add a contact"
        },
        {
          "name": "Remove",
          "value": "remove",
          "action": "Remove a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "editContactPoint"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Points",
      "name": "points",
      "type": "number",
      "default": 0,
      "displayOptions": {
        "show": {
          "operation": [
            "editContactPoint"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 30,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 30
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Search",
          "name": "search",
          "type": "string",
          "displayOptions": {
            "show": {
              "/resource": [
                "contact"
              ],
              "/operation": [
                "getAll"
              ]
            }
          },
          "default": "",
          "description": "String or search command to filter entities by"
        },
        {
          "displayName": "Order By",
          "name": "orderBy",
          "type": "string",
          "displayOptions": {
            "show": {
              "/resource": [
                "contact"
              ],
              "/operation": [
                "getAll"
              ]
            }
          },
          "default": "",
          "description": "Column to sort by. Can use any column listed in the response."
        },
        {
          "displayName": "Order By Dir",
          "name": "orderByDir",
          "type": "options",
          "displayOptions": {
            "show": {
              "/resource": [
                "contact"
              ],
              "/operation": [
                "getAll"
              ]
            }
          },
          "default": "",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "description": "Sort direction: ASC or DESC"
        },
        {
          "displayName": "Published Only",
          "name": "publishedOnly",
          "type": "boolean",
          "displayOptions": {
            "show": {
              "/resource": [
                "contact"
              ],
              "/operation": [
                "getAll"
              ]
            }
          },
          "default": false,
          "description": "Whether to return currently published entities"
        },
        {
          "displayName": "Minimal",
          "name": "minimal",
          "type": "boolean",
          "displayOptions": {
            "show": {
              "/resource": [
                "contact"
              ],
              "/operation": [
                "getAll"
              ]
            }
          },
          "default": false,
          "description": "Whether to return array of entities without additional lists in it"
        },
        {
          "displayName": "RAW Data",
          "name": "rawData",
          "type": "boolean",
          "default": true,
          "description": "By default only the data of the fields get returned. If this options gets set the RAW response with all data gets returned."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        },
        "hide": {
          "operation": [
            "sendEmail",
            "editDoNotContactList",
            "editContactPoint"
          ]
        }
      }
    },
    {
      "displayName": "Campaign Email Name or ID",
      "name": "campaignEmailId",
      "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"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCampaignEmails"
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "sendEmail"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add contact to a segment",
          "action": "Add a contact to a segment"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove contact from a segment",
          "action": "Remove a contact from a segment"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contactSegment"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactSegment"
          ],
          "operation": [
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Segment Name or ID",
      "name": "segmentId",
      "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"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSegments"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add contact to a campaign",
          "action": "Add a campaign contact"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove contact from a campaign",
          "action": "Remove a campaign contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "campaignContact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "campaignContact"
          ],
          "operation": [
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Campaign Name or ID",
      "name": "campaignId",
      "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"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCampaigns"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add contact to a company",
          "action": "Add a company contact"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a contact from a company",
          "action": "Remove a company contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "companyContact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "The ID of the contact",
      "displayOptions": {
        "show": {
          "resource": [
            "companyContact"
          ],
          "operation": [
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "companyId",
      "type": "string",
      "default": "",
      "description": "The ID of the company",
      "displayOptions": {
        "show": {
          "resource": [
            "companyContact"
          ],
          "operation": [
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "action": "Send an email to a segment"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "segmentEmail"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Segment Email Name or ID",
      "name": "segmentEmailId",
      "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"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSegmentEmails"
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new company",
      "resource": "company"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a company",
      "resource": "company"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get data of a company",
      "resource": "company"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get data of many companies",
      "resource": "company"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a company",
      "resource": "company"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new contact",
      "resource": "contact"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a contact",
      "resource": "contact"
    },
    {
      "operation": "editContactPoint",
      "name": "Edit Contact Points",
      "description": "Edit contact's points",
      "resource": "contact"
    },
    {
      "operation": "editDoNotContactList",
      "name": "Edit Do Not Contact List",
      "description": "Add/remove contacts from/to the do not contact list",
      "resource": "contact"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get data of a contact",
      "resource": "contact"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get data of many contacts",
      "resource": "contact"
    },
    {
      "operation": "sendEmail",
      "name": "Send Email",
      "description": "Send email to contact",
      "resource": "contact"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a contact",
      "resource": "contact"
    },
    {
      "operation": "add",
      "name": "Add",
      "resource": "contact"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "resource": "contact"
    },
    {
      "operation": "add",
      "name": "Add",
      "resource": "contact"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "resource": "contact"
    },
    {
      "operation": "add",
      "name": "Add",
      "description": "Add contact to a segment",
      "resource": "contactSegment"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "description": "Remove contact from a segment",
      "resource": "contactSegment"
    },
    {
      "operation": "add",
      "name": "Add",
      "description": "Add contact to a campaign",
      "resource": "campaignContact"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "description": "Remove contact from a campaign",
      "resource": "campaignContact"
    },
    {
      "operation": "add",
      "name": "Add",
      "description": "Add contact to a company",
      "resource": "companyContact"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "description": "Remove a contact from a company",
      "resource": "companyContact"
    },
    {
      "operation": "send",
      "name": "Send",
      "resource": "segmentEmail"
    }
  ]

credentials_required:
  [
    {
      "name": "mauticApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "credentials"
          ]
        }
      }
    },
    {
      "name": "mauticOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


node_type: nodes-base.mauticTrigger
package_name: n8n-nodes-base
display_name: Mautic Trigger
description: Handle Mautic events via webhooks
category: trigger
development_style: programmatic
version: 1
operations: []
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Mautic Trigger node documentation
  description: Learn how to use the Mautic Trigger node in n8n. Follow technical documentation to integrate Mautic Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Mautic Trigger node

  [Mautic](https://www.mautic.org/){:target=_blank .external-link} is an open-source marketing automation software that helps online businesses automate their repetitive marketing tasks such as lead generation, contact scoring, contact segmentation, and marketing campaigns.

  /// note | Credentials
  You can find authentication information for this node [here](/integrations/builtin/credentials/mautic.md).
  ///

  ///  note  | Examples and templates
  For usage examples and templates to help you get started, refer to n8n's [Mautic Trigger integrations](https://n8n.io/integrations/mautic-trigger/){:target=_blank .external-link} page.
  ///

  ## Related resources

  n8n provides an app node for Mautic. You can find the node docs [here](/integrations/builtin/app-nodes/n8n-nodes-base.mautic.md).

  View [example workflows and related content](https://n8n.io/integrations/mautic/){:target=_blank .external-link} on n8n's website.

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "credentials",
      "options": [
        {
          "name": "Credentials",
          "value": "credentials"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Event Names or IDs",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "typeOptions": {
        "loadOptionsMethod": "getEvents"
      }
    },
    {
      "displayName": "Events Order",
      "name": "eventsOrder",
      "type": "options",
      "default": "ASC",
      "description": "Order direction for queued events in one webhook. Can be “DESC” or “ASC”.",
      "options": [
        {
          "name": "ASC",
          "value": "ASC"
        },
        {
          "name": "DESC",
          "value": "DESC"
        }
      ]
    }
  ]

credentials_required:
  [
    {
      "name": "mauticApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "credentials"
          ]
        }
      }
    },
    {
      "name": "mauticOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


node_type: nodes-base.mediumTool
package_name: n8n-nodes-base
display_name: Medium Tool
description: Consume Medium API (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 1
outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.medium
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Medium node documentation
  description: Learn how to use the Medium node in n8n. Follow technical documentation to integrate Medium node into your workflows.
  contentType: [integration, reference]
  ---

  # Medium node

  Use the Medium node to automate work in Medium, and integrate Medium with other applications. n8n has built-in support for a wide range of Medium features, including creating posts, and getting publications. 

  On this page, you'll find a list of operations the Medium node supports and links to more resources.

  /// warning | Medium API no longer supported
  Medium has stopped supporting the Medium API. The Medium node still appears within n8n, but you won't be able to configure new API keys to authenticate with.

  Refer to [Medium credentials](/integrations/builtin/credentials/medium.md) for guidance on setting up existing API keys.
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"


  ## Operations

  * Post
      * Create a post
  * Publication
      * Get all publications

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'medium') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Medium"
    },
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "accessToken",
      "options": [
        {
          "name": "Access Token",
          "value": "accessToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "post",
      "options": [
        {
          "name": "Post",
          "value": "post"
        },
        {
          "name": "Publication",
          "value": "publication"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a post",
          "action": "Create a post"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Publication",
      "name": "publication",
      "type": "boolean",
      "default": false,
      "description": "Whether you are posting for a publication",
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Publication Name or ID",
      "name": "publicationId",
      "type": "options",
      "default": "",
      "description": "Publication IDs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ],
          "publication": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getPublications"
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Title of the post. Max Length : 100 characters.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "post"
          ]
        }
      }
    },
    {
      "displayName": "Content Format",
      "name": "contentFormat",
      "type": "options",
      "default": "",
      "description": "The format of the content to be posted",
      "options": [
        {
          "name": "HTML",
          "value": "html"
        },
        {
          "name": "Markdown",
          "value": "markdown"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "post"
          ]
        }
      }
    },
    {
      "displayName": "Content",
      "name": "content",
      "type": "string",
      "default": "",
      "description": "The body of the post, in a valid semantic HTML fragment, or Markdown",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "post"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Canonical Url",
          "name": "canonicalUrl",
          "type": "string",
          "default": "",
          "description": "The original home of this content, if it was originally published elsewhere"
        },
        {
          "displayName": "License",
          "name": "license",
          "type": "options",
          "default": "all-rights-reserved",
          "options": [
            {
              "name": "all-rights-reserved",
              "value": "all-rights-reserved"
            },
            {
              "name": "cc-40-by",
              "value": "cc-40-by"
            },
            {
              "name": "cc-40-by-nc",
              "value": "cc-40-by-nc"
            },
            {
              "name": "cc-40-by-nc-nd",
              "value": "cc-40-by-nc-nd"
            },
            {
              "name": "cc-40-by-nc-sa",
              "value": "cc-40-by-nc-sa"
            },
            {
              "name": "cc-40-by-nd",
              "value": "cc-40-by-nd"
            },
            {
              "name": "cc-40-by-sa",
              "value": "cc-40-by-sa"
            },
            {
              "name": "cc-40-zero",
              "value": "cc-40-zero"
            },
            {
              "name": "public-domain",
              "value": "public-domain"
            }
          ],
          "description": "License of the post"
        },
        {
          "displayName": "Notify Followers",
          "name": "notifyFollowers",
          "type": "boolean",
          "default": false,
          "description": "Whether to notify followers that the user has published"
        },
        {
          "displayName": "Publish Status",
          "name": "publishStatus",
          "default": "public",
          "type": "options",
          "options": [
            {
              "name": "Public",
              "value": "public"
            },
            {
              "name": "Draft",
              "value": "draft"
            },
            {
              "name": "Unlisted",
              "value": "unlisted"
            }
          ],
          "description": "The status of the post"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "placeholder": "open-source,mlh,fellowship",
          "description": "Comma-separated strings to be used as tags for post classification. Max allowed tags: 5. Max tag length: 25 characters."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "post"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "publication",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many publications",
          "action": "Get many publications"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "publication"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "publication"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "publication"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 200
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a post",
      "resource": "post"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many publications",
      "resource": "publication"
    }
  ]

credentials_required:
  [
    {
      "name": "mediumApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "accessToken"
          ]
        }
      }
    },
    {
      "name": "mediumOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


node_type: nodes-base.medium
package_name: n8n-nodes-base
display_name: Medium
description: Consume Medium API
category: output
development_style: programmatic
version: 1
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Medium node documentation
  description: Learn how to use the Medium node in n8n. Follow technical documentation to integrate Medium node into your workflows.
  contentType: [integration, reference]
  ---

  # Medium node

  Use the Medium node to automate work in Medium, and integrate Medium with other applications. n8n has built-in support for a wide range of Medium features, including creating posts, and getting publications. 

  On this page, you'll find a list of operations the Medium node supports and links to more resources.

  /// warning | Medium API no longer supported
  Medium has stopped supporting the Medium API. The Medium node still appears within n8n, but you won't be able to configure new API keys to authenticate with.

  Refer to [Medium credentials](/integrations/builtin/credentials/medium.md) for guidance on setting up existing API keys.
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"


  ## Operations

  * Post
      * Create a post
  * Publication
      * Get all publications

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'medium') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "accessToken",
      "options": [
        {
          "name": "Access Token",
          "value": "accessToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "post",
      "options": [
        {
          "name": "Post",
          "value": "post"
        },
        {
          "name": "Publication",
          "value": "publication"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a post",
          "action": "Create a post"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Publication",
      "name": "publication",
      "type": "boolean",
      "default": false,
      "description": "Whether you are posting for a publication",
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Publication Name or ID",
      "name": "publicationId",
      "type": "options",
      "default": "",
      "description": "Publication IDs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ],
          "publication": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getPublications"
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Title of the post. Max Length : 100 characters.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "post"
          ]
        }
      }
    },
    {
      "displayName": "Content Format",
      "name": "contentFormat",
      "type": "options",
      "default": "",
      "description": "The format of the content to be posted",
      "options": [
        {
          "name": "HTML",
          "value": "html"
        },
        {
          "name": "Markdown",
          "value": "markdown"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "post"
          ]
        }
      }
    },
    {
      "displayName": "Content",
      "name": "content",
      "type": "string",
      "default": "",
      "description": "The body of the post, in a valid semantic HTML fragment, or Markdown",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "post"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Canonical Url",
          "name": "canonicalUrl",
          "type": "string",
          "default": "",
          "description": "The original home of this content, if it was originally published elsewhere"
        },
        {
          "displayName": "License",
          "name": "license",
          "type": "options",
          "default": "all-rights-reserved",
          "options": [
            {
              "name": "all-rights-reserved",
              "value": "all-rights-reserved"
            },
            {
              "name": "cc-40-by",
              "value": "cc-40-by"
            },
            {
              "name": "cc-40-by-nc",
              "value": "cc-40-by-nc"
            },
            {
              "name": "cc-40-by-nc-nd",
              "value": "cc-40-by-nc-nd"
            },
            {
              "name": "cc-40-by-nc-sa",
              "value": "cc-40-by-nc-sa"
            },
            {
              "name": "cc-40-by-nd",
              "value": "cc-40-by-nd"
            },
            {
              "name": "cc-40-by-sa",
              "value": "cc-40-by-sa"
            },
            {
              "name": "cc-40-zero",
              "value": "cc-40-zero"
            },
            {
              "name": "public-domain",
              "value": "public-domain"
            }
          ],
          "description": "License of the post"
        },
        {
          "displayName": "Notify Followers",
          "name": "notifyFollowers",
          "type": "boolean",
          "default": false,
          "description": "Whether to notify followers that the user has published"
        },
        {
          "displayName": "Publish Status",
          "name": "publishStatus",
          "default": "public",
          "type": "options",
          "options": [
            {
              "name": "Public",
              "value": "public"
            },
            {
              "name": "Draft",
              "value": "draft"
            },
            {
              "name": "Unlisted",
              "value": "unlisted"
            }
          ],
          "description": "The status of the post"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "placeholder": "open-source,mlh,fellowship",
          "description": "Comma-separated strings to be used as tags for post classification. Max allowed tags: 5. Max tag length: 25 characters."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "post"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "publication",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many publications",
          "action": "Get many publications"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "publication"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "publication"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "publication"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 200
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a post",
      "resource": "post"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many publications",
      "resource": "publication"
    }
  ]

credentials_required:
  [
    {
      "name": "mediumApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "accessToken"
          ]
        }
      }
    },
    {
      "name": "mediumOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


