Components
Mautic
Simplifying campaign design and optimization with a user-friendly click-and-drag interface allowing you to build complex campaigns.
Simplifying campaign design and optimization with a user-friendly click-and-drag interface allowing you to build complex campaigns.
Categories: Marketing Automation
Type: mautic/v1
Connections
Version: 1
Mautic Basic Auth
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
baseUrl | Base URL | STRING | Open your Mautic instance and copy the URL from the address bar. If your dashboard link is "https://mautic.ddev.site/s/dashboard", set your base URL as "https://mautic.ddev.site/". | true |
username | Username | STRING | true | |
password | Password | STRING | true |
Actions
Create Company
Name: createCompany
Creates a new company.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
companyname | Company Name | STRING | true | |
isPublished | Is Published | INTEGER Options1, 0 | Will the company be published after creation. | true |
overwriteWithBlank | Overwrite With Blank | BOOLEAN Optionstrue, false | If true, then empty values are set to fields.Otherwise empty values are skipped. | false |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
id | STRING | ID of the company. |
isPublished | BOOLEAN Optionstrue, false | Whether the company is published. |
dateAdded | DATE | Date/time company was created. |
createdBy | INTEGER | ID of the user that created the company. |
createdByUser | STRING | Name of the user that created the company. |
dateModified | DATE | Date/time company was last modified. |
modifiedBy | INTEGER | ID of the user that last modified the company. |
modifiedByUser | STRING | Name of the user that last modified the company. |
fields | ARRAY Items[] | Custom fields for the company. |
Output Example
Create Contact
Name: createContact
Creates a new contact.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
firstname | First Name | STRING | true | |
lastname | Last Name | STRING | true | |
STRING | true | |||
overwriteWithBlank | Overwrite With Blank | BOOLEAN Optionstrue, false | If true, then empty values are set to fields.Otherwise empty values are skipped. | false |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
id | STRING | ID of the contact. |
isPublished | BOOLEAN Optionstrue, false | Whether the contact is published. |
dateAdded | DATE | Date/time contact was created. |
createdBy | INTEGER | ID of the user that created the contact. |
createdByUser | STRING | Name of the user that created the contact. |
dateModified | DATE | Date/time company was last modified. |
modifiedBy | INTEGER | ID of the user that last modified the contact. |
modifiedByUser | STRING | Name of the user that last modified the contact. |
owner | OBJECT Properties{} | User object that owns the contact. |
points | INTEGER | Contact's current number of points. |
lastActive | DATE | Date/time for when the contact was last recorded as active. |
dateIdentified | DATE | Date/time when the contact identified themselves. |
color | STRING | Hex value given to contact from Point Trigger definitions based on the number of points the contact has been awarded. |
ipAddresses | ARRAY Items[] | Array of IPs currently associated with this contact. |
fields | ARRAY Items[] | Custom fields for the contact. |
tags | ARRAY Items[] | Array of tags associated with this contact. |
utmtags | ARRAY Items[] | Array of UTM Tags associated with this contact. |
doNotContact | ARRAY Items[] | Array of Do Not Contact objects. |
Output Example
Get Company
Name: getCompany
Get individual company.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
id | Company ID | STRING | ID of the company you want to retrieve. | true |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
id | STRING | ID of the company. |
isPublished | BOOLEAN Optionstrue, false | Whether the company is published. |
dateAdded | DATE | Date/time company was created. |
createdBy | INTEGER | ID of the user that created the company. |
createdByUser | STRING | Name of the user that created the company. |
dateModified | DATE | Date/time company was last modified. |
modifiedBy | INTEGER | ID of the user that last modified the company. |
modifiedByUser | STRING | Name of the user that last modified the company. |
fields | ARRAY Items[] | Custom fields for the company. |
Output Example
Get Contact
Name: getContact
Get individual contact.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
id | Contact ID | STRING | ID of the contact you want to retrieve. | true |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
id | STRING | ID of the contact. |
isPublished | BOOLEAN Optionstrue, false | Whether the contact is published. |
dateAdded | DATE | Date/time contact was created. |
createdBy | INTEGER | ID of the user that created the contact. |
createdByUser | STRING | Name of the user that created the contact. |
dateModified | DATE | Date/time company was last modified. |
modifiedBy | INTEGER | ID of the user that last modified the contact. |
modifiedByUser | STRING | Name of the user that last modified the contact. |
owner | OBJECT Properties{} | User object that owns the contact. |
points | INTEGER | Contact's current number of points. |
lastActive | DATE | Date/time for when the contact was last recorded as active. |
dateIdentified | DATE | Date/time when the contact identified themselves. |
color | STRING | Hex value given to contact from Point Trigger definitions based on the number of points the contact has been awarded. |
ipAddresses | ARRAY Items[] | Array of IPs currently associated with this contact. |
fields | ARRAY Items[] | Custom fields for the contact. |
tags | ARRAY Items[] | Array of tags associated with this contact. |
utmtags | ARRAY Items[] | Array of UTM Tags associated with this contact. |
doNotContact | ARRAY Items[] | Array of Do Not Contact objects. |