Mautic
App · 15 actions
Add and update Mautic contacts from sign-ups and forms, tag and score them, put them in segments and campaigns, send them emails and unsubscribe them. Start a workflow for a new contact, a form submission or a contact added to a segment.
Actions
| Action | What it does |
|---|---|
| Add or subtract points | Add points to a contact's score, or subtract them, such as 10 for attending a webinar. |
| Add tags | Add tags to a contact, keeping the ones it has. |
| Add to campaign | Add a contact to a campaign, which starts the campaign's steps for it when Mautic next runs them. |
| Add to segment | Add a contact to a segment, such as a newsletter list. |
| Change stage | Move a contact to a stage of its lifecycle, such as Lead or Customer. |
| Create or update contact | Add a contact, such as someone who signed up, or update the one with the same email. |
| Delete contact | Delete a contact and its history from Mautic for good. |
| Find contacts | Find contacts by name, email or company, in a segment or with a tag, newest first. |
| Get contact | Get a contact's details, fields, tags, points, segments and campaigns. |
| Remove from campaign | Take a contact out of a campaign, stopping its steps for the contact. |
| Remove from segment | Take a contact out of a segment. |
| Remove tags | Take tags off a contact. |
| Resubscribe contact | Let Mautic email a contact again, taking off its Do Not Contact. |
| Send email | Send one of Mautic's emails to a contact, such as a welcome email, with the contact's own details filled in. |
| Unsubscribe contact | Stop Mautic emailing a contact (Do Not Contact), such as when they ask by phone. |
Add or subtract points
Add points to a contact's score, or subtract them, such as 10 for attending a webinar.
Inputs
- Contact
contacttextRequired - The contact's ID or email address.
- Points
pointsnumberRequired - How many points to add. Use a minus number, such as -5, to subtract.
- Reason
reasontext - Why, as shown in the contact's history, such as Attended webinar.
Outputs
changenumber- The points added; negative when subtracted
companytext- Its primary company
date_addedtext- When it was added (ISO 8601)
date_identifiedtext- When Mautic first knew who it is (ISO 8601)
do_not_contactlist- The channels it mustn't be contacted on: email, sms
emailtext- Its email address
fieldsobject- Every contact field's value, by the field's alias, such as city
first_nametext- First name
idnumber- The contact's ID
last_activetext- When it was last active (ISO 8601)
last_nametext- Last name
linktext- A link to it in Mautic
mobiletext- Mobile number
ownertext- The Mautic user who owns it
phonetext- Phone number
pointsnumber- Its points
stagetext- The stage it's in; blank for none
tagslist- Its tags
unsubscribedtrue/false- True when it mustn't be sent email (Do Not Contact)
Example output
{
"change": 10,
"company": "Analytical Engines",
"date_added": "2026-10-20T09:00:00+00:00",
"date_identified": "2026-10-20T09:00:00+00:00",
"do_not_contact": [],
"email": "ada@example.com",
"fields": {
"city": "London",
"company": "Analytical Engines",
"email": "ada@example.com",
"firstname": "Ada",
"lastname": "Lovelace",
"points": 15
},
"first_name": "Ada",
"id": 42,
"last_active": "2026-10-28T11:02:00+00:00",
"last_name": "Lovelace",
"link": "https://mautic.example.com/s/contacts/view/42",
"mobile": "",
"owner": "Sam Marketer",
"phone": "+44 20 7946 0000",
"points": 15,
"stage": "Lead",
"tags": [
"newsletter",
"webinar"
],
"unsubscribed": false
}Add tags
Add tags to a contact, keeping the ones it has.
Inputs
- Contact
contacttextRequired - The contact's ID or email address.
- Tags
tagslistRequired - Tags, such as newsletter or VIP.
Outputs
companytext- Its primary company
date_addedtext- When it was added (ISO 8601)
date_identifiedtext- When Mautic first knew who it is (ISO 8601)
do_not_contactlist- The channels it mustn't be contacted on: email, sms
emailtext- Its email address
fieldsobject- Every contact field's value, by the field's alias, such as city
first_nametext- First name
idnumber- The contact's ID
last_activetext- When it was last active (ISO 8601)
last_nametext- Last name
linktext- A link to it in Mautic
mobiletext- Mobile number
ownertext- The Mautic user who owns it
phonetext- Phone number
pointsnumber- Its points
stagetext- The stage it's in; blank for none
tagslist- Its tags
unsubscribedtrue/false- True when it mustn't be sent email (Do Not Contact)
Example output
{
"company": "Analytical Engines",
"date_added": "2026-10-20T09:00:00+00:00",
"date_identified": "2026-10-20T09:00:00+00:00",
"do_not_contact": [],
"email": "ada@example.com",
"fields": {
"city": "London",
"company": "Analytical Engines",
"email": "ada@example.com",
"firstname": "Ada",
"lastname": "Lovelace",
"points": 15
},
"first_name": "Ada",
"id": 42,
"last_active": "2026-10-28T11:02:00+00:00",
"last_name": "Lovelace",
"link": "https://mautic.example.com/s/contacts/view/42",
"mobile": "",
"owner": "Sam Marketer",
"phone": "+44 20 7946 0000",
"points": 15,
"stage": "Lead",
"tags": [
"newsletter",
"webinar"
],
"unsubscribed": false
}Add to campaign
Add a contact to a campaign, which starts the campaign's steps for it when Mautic next runs them.
Inputs
- Contact
contacttextRequired - The contact's ID or email address.
- Campaign
campaigntextRequired - The campaign. Pick one, or type its name or ID.
Outputs
addedtrue/false- True once it's added
campaign_idnumber- The campaign's ID
campaign_nametext- The campaign's name
contact_idnumber- The contact's ID
Example output
{
"added": true,
"campaign_id": 3,
"campaign_name": "Welcome series",
"contact_id": 42
}Add to segment
Add a contact to a segment, such as a newsletter list.
Inputs
- Contact
contacttextRequired - The contact's ID or email address.
- Segment
segmenttextRequired - The segment. Pick one, or type its name or ID.
Outputs
addedtrue/false- True once it's added
contact_idnumber- The contact's ID
segment_idnumber- The segment's ID
segment_nametext- The segment's name
Example output
{
"added": true,
"contact_id": 42,
"segment_id": 3,
"segment_name": "Newsletter"
}Change stage
Move a contact to a stage of its lifecycle, such as Lead or Customer.
Inputs
- Contact
contacttextRequired - The contact's ID or email address.
- Stage
stagetextRequired - The stage. Pick one, or type its name or ID.
Outputs
companytext- Its primary company
date_addedtext- When it was added (ISO 8601)
date_identifiedtext- When Mautic first knew who it is (ISO 8601)
do_not_contactlist- The channels it mustn't be contacted on: email, sms
emailtext- Its email address
fieldsobject- Every contact field's value, by the field's alias, such as city
first_nametext- First name
idnumber- The contact's ID
last_activetext- When it was last active (ISO 8601)
last_nametext- Last name
linktext- A link to it in Mautic
mobiletext- Mobile number
ownertext- The Mautic user who owns it
phonetext- Phone number
pointsnumber- Its points
stagetext- The stage it's in; blank for none
tagslist- Its tags
unsubscribedtrue/false- True when it mustn't be sent email (Do Not Contact)
Example output
{
"company": "Analytical Engines",
"date_added": "2026-10-20T09:00:00+00:00",
"date_identified": "2026-10-20T09:00:00+00:00",
"do_not_contact": [],
"email": "ada@example.com",
"fields": {
"city": "London",
"company": "Analytical Engines",
"email": "ada@example.com",
"firstname": "Ada",
"lastname": "Lovelace",
"points": 15
},
"first_name": "Ada",
"id": 42,
"last_active": "2026-10-28T11:02:00+00:00",
"last_name": "Lovelace",
"link": "https://mautic.example.com/s/contacts/view/42",
"mobile": "",
"owner": "Sam Marketer",
"phone": "+44 20 7946 0000",
"points": 15,
"stage": "Lead",
"tags": [
"newsletter",
"webinar"
],
"unsubscribed": false
}Create or update contact
Add a contact, such as someone who signed up, or update the one with the same email. Tags given are added to the ones it has.
Inputs
- Email
emailtextRequired - The contact's email address. A contact with this address is updated rather than added again.
- First name
first_nametext - The contact's first name.
- Last name
last_nametext - The contact's last name.
- Company
companytext - The company they work for.
- Phone
phonetext - Their phone number.
- Tags
tagslist - Tags to add, such as newsletter or webinar.
- Other fields
fieldsobject - Values for any other contact fields, such as City or your own fields. Fill in only what should change.
Outputs
companytext- Its primary company
createdtrue/false- True when the contact is new, false when it was updated
date_addedtext- When it was added (ISO 8601)
date_identifiedtext- When Mautic first knew who it is (ISO 8601)
do_not_contactlist- The channels it mustn't be contacted on: email, sms
emailtext- Its email address
fieldsobject- Every contact field's value, by the field's alias, such as city
first_nametext- First name
idnumber- The contact's ID
last_activetext- When it was last active (ISO 8601)
last_nametext- Last name
linktext- A link to it in Mautic
mobiletext- Mobile number
ownertext- The Mautic user who owns it
phonetext- Phone number
pointsnumber- Its points
stagetext- The stage it's in; blank for none
tagslist- Its tags
unsubscribedtrue/false- True when it mustn't be sent email (Do Not Contact)
Example output
{
"company": "Analytical Engines",
"created": true,
"date_added": "2026-10-20T09:00:00+00:00",
"date_identified": "2026-10-20T09:00:00+00:00",
"do_not_contact": [],
"email": "ada@example.com",
"fields": {
"city": "London",
"company": "Analytical Engines",
"email": "ada@example.com",
"firstname": "Ada",
"lastname": "Lovelace",
"points": 15
},
"first_name": "Ada",
"id": 42,
"last_active": "2026-10-28T11:02:00+00:00",
"last_name": "Lovelace",
"link": "https://mautic.example.com/s/contacts/view/42",
"mobile": "",
"owner": "Sam Marketer",
"phone": "+44 20 7946 0000",
"points": 15,
"stage": "Lead",
"tags": [
"newsletter",
"webinar"
],
"unsubscribed": false
}Delete contact
Delete a contact and its history from Mautic for good.
Inputs
- Contact
contacttextRequired - The contact's ID or email address.
Outputs
deletedtrue/false- True once it's deleted
emailtext- Its email address
idnumber- The contact's ID
nametext- Its name
Example output
{
"deleted": true,
"email": "ada@example.com",
"id": 42,
"name": "Ada Lovelace"
}Find contacts
Find contacts by name, email or company, in a segment or with a tag, newest first.
Inputs
- Search
querytext - Words in the contact's name, email or company, or a Mautic search such as email:ada@example.com. Leave blank for everyone.
- Segment
segmenttext - Only contacts in this segment.
- Tag
tagtext - Only contacts with this tag.
- How many
limitnumber - The most to return, up to 200. Defaults to 25.From 1 to 200.
Outputs
contactslist- The contacts found, newest first
countnumber- How many are returned
totalnumber- How many match in all
Example output
{
"contacts": [
{
"company": "Analytical Engines",
"date_added": "2026-10-20T09:00:00+00:00",
"date_identified": "2026-10-20T09:00:00+00:00",
"do_not_contact": [],
"email": "ada@example.com",
"fields": {
"city": "London",
"company": "Analytical Engines",
"email": "ada@example.com",
"firstname": "Ada",
"lastname": "Lovelace",
"points": 15
},
"first_name": "Ada",
"id": 42,
"last_active": "2026-10-28T11:02:00+00:00",
"last_name": "Lovelace",
"link": "https://mautic.example.com/s/contacts/view/42",
"mobile": "",
"owner": "Sam Marketer",
"phone": "+44 20 7946 0000",
"points": 15,
"stage": "Lead",
"tags": [
"newsletter",
"webinar"
],
"unsubscribed": false
}
],
"count": 1,
"total": 1
}Get contact
Get a contact's details, fields, tags, points, segments and campaigns.
Inputs
- Contact
contacttextRequired - The contact's ID or email address.
Outputs
campaignslist- The campaigns it's in
companytext- Its primary company
date_addedtext- When it was added (ISO 8601)
date_identifiedtext- When Mautic first knew who it is (ISO 8601)
do_not_contactlist- The channels it mustn't be contacted on: email, sms
emailtext- Its email address
fieldsobject- Every contact field's value, by the field's alias, such as city
first_nametext- First name
idnumber- The contact's ID
last_activetext- When it was last active (ISO 8601)
last_nametext- Last name
linktext- A link to it in Mautic
mobiletext- Mobile number
ownertext- The Mautic user who owns it
phonetext- Phone number
pointsnumber- Its points
segmentslist- The segments it's in
stagetext- The stage it's in; blank for none
tagslist- Its tags
unsubscribedtrue/false- True when it mustn't be sent email (Do Not Contact)
Example output
{
"campaigns": [
{
"id": 2,
"name": "Welcome series"
}
],
"company": "Analytical Engines",
"date_added": "2026-10-20T09:00:00+00:00",
"date_identified": "2026-10-20T09:00:00+00:00",
"do_not_contact": [],
"email": "ada@example.com",
"fields": {
"city": "London",
"company": "Analytical Engines",
"email": "ada@example.com",
"firstname": "Ada",
"lastname": "Lovelace",
"points": 15
},
"first_name": "Ada",
"id": 42,
"last_active": "2026-10-28T11:02:00+00:00",
"last_name": "Lovelace",
"link": "https://mautic.example.com/s/contacts/view/42",
"mobile": "",
"owner": "Sam Marketer",
"phone": "+44 20 7946 0000",
"points": 15,
"segments": [
{
"id": 3,
"name": "Newsletter"
}
],
"stage": "Lead",
"tags": [
"newsletter",
"webinar"
],
"unsubscribed": false
}Remove from campaign
Take a contact out of a campaign, stopping its steps for the contact.
Inputs
- Contact
contacttextRequired - The contact's ID or email address.
- Campaign
campaigntextRequired - The campaign. Pick one, or type its name or ID.
Outputs
campaign_idnumber- The campaign's ID
campaign_nametext- The campaign's name
contact_idnumber- The contact's ID
removedtrue/false- True once it's removed
Example output
{
"campaign_id": 3,
"campaign_name": "Welcome series",
"contact_id": 42,
"removed": true
}Remove from segment
Take a contact out of a segment. Mautic keeps it out even if the segment's filters match it.
Inputs
- Contact
contacttextRequired - The contact's ID or email address.
- Segment
segmenttextRequired - The segment. Pick one, or type its name or ID.
Outputs
contact_idnumber- The contact's ID
removedtrue/false- True once it's removed
segment_idnumber- The segment's ID
segment_nametext- The segment's name
Example output
{
"contact_id": 42,
"removed": true,
"segment_id": 3,
"segment_name": "Newsletter"
}Remove tags
Take tags off a contact.
Inputs
- Contact
contacttextRequired - The contact's ID or email address.
- Tags
tagslistRequired - Tags, such as newsletter or VIP.
Outputs
companytext- Its primary company
date_addedtext- When it was added (ISO 8601)
date_identifiedtext- When Mautic first knew who it is (ISO 8601)
do_not_contactlist- The channels it mustn't be contacted on: email, sms
emailtext- Its email address
fieldsobject- Every contact field's value, by the field's alias, such as city
first_nametext- First name
idnumber- The contact's ID
last_activetext- When it was last active (ISO 8601)
last_nametext- Last name
linktext- A link to it in Mautic
mobiletext- Mobile number
ownertext- The Mautic user who owns it
phonetext- Phone number
pointsnumber- Its points
stagetext- The stage it's in; blank for none
tagslist- Its tags
unsubscribedtrue/false- True when it mustn't be sent email (Do Not Contact)
Example output
{
"company": "Analytical Engines",
"date_added": "2026-10-20T09:00:00+00:00",
"date_identified": "2026-10-20T09:00:00+00:00",
"do_not_contact": [],
"email": "ada@example.com",
"fields": {
"city": "London",
"company": "Analytical Engines",
"email": "ada@example.com",
"firstname": "Ada",
"lastname": "Lovelace",
"points": 15
},
"first_name": "Ada",
"id": 42,
"last_active": "2026-10-28T11:02:00+00:00",
"last_name": "Lovelace",
"link": "https://mautic.example.com/s/contacts/view/42",
"mobile": "",
"owner": "Sam Marketer",
"phone": "+44 20 7946 0000",
"points": 15,
"stage": "Lead",
"tags": [
"newsletter",
"webinar"
],
"unsubscribed": false
}Resubscribe contact
Let Mautic email a contact again, taking off its Do Not Contact.
Inputs
- Contact
contacttextRequired - The contact's ID or email address.
- Channel
channeltext - What the contact is resubscribed to. Defaults to email.One of:
email,sms(Text message). Default:email.
Outputs
companytext- Its primary company
date_addedtext- When it was added (ISO 8601)
date_identifiedtext- When Mautic first knew who it is (ISO 8601)
do_not_contactlist- The channels it mustn't be contacted on: email, sms
emailtext- Its email address
fieldsobject- Every contact field's value, by the field's alias, such as city
first_nametext- First name
idnumber- The contact's ID
last_activetext- When it was last active (ISO 8601)
last_nametext- Last name
linktext- A link to it in Mautic
mobiletext- Mobile number
ownertext- The Mautic user who owns it
phonetext- Phone number
pointsnumber- Its points
stagetext- The stage it's in; blank for none
tagslist- Its tags
unsubscribedtrue/false- True when it mustn't be sent email (Do Not Contact)
Example output
{
"company": "Analytical Engines",
"date_added": "2026-10-20T09:00:00+00:00",
"date_identified": "2026-10-20T09:00:00+00:00",
"do_not_contact": [],
"email": "ada@example.com",
"fields": {
"city": "London",
"company": "Analytical Engines",
"email": "ada@example.com",
"firstname": "Ada",
"lastname": "Lovelace",
"points": 15
},
"first_name": "Ada",
"id": 42,
"last_active": "2026-10-28T11:02:00+00:00",
"last_name": "Lovelace",
"link": "https://mautic.example.com/s/contacts/view/42",
"mobile": "",
"owner": "Sam Marketer",
"phone": "+44 20 7946 0000",
"points": 15,
"stage": "Lead",
"tags": [
"newsletter",
"webinar"
],
"unsubscribed": false
}Send email
Send one of Mautic's emails to a contact, such as a welcome email, with the contact's own details filled in.
Inputs
- Contact
contacttextRequired - The contact's ID or email address.
- Email
emailtextRequired - The email to send, best a template email. Pick one, or type its name or ID.
Outputs
contact_idnumber- The contact's ID
email_idnumber- The email's ID
email_nametext- The email's name
senttrue/false- True once Mautic has sent it
subjecttext- Its subject
Example output
{
"contact_id": 42,
"email_id": 5,
"email_name": "Welcome",
"sent": true,
"subject": "Welcome to Acme, {contactfield=firstname}"
}Unsubscribe contact
Stop Mautic emailing a contact (Do Not Contact), such as when they ask by phone. Their history stays.
Inputs
- Contact
contacttextRequired - The contact's ID or email address.
- Channel
channeltext - What the contact is unsubscribed from. Defaults to email.One of:
email,sms(Text message). Default:email. - Comments
commentstext - Why, as shown on the contact in Mautic, such as Asked by phone.
Outputs
companytext- Its primary company
date_addedtext- When it was added (ISO 8601)
date_identifiedtext- When Mautic first knew who it is (ISO 8601)
do_not_contactlist- The channels it mustn't be contacted on: email, sms
emailtext- Its email address
fieldsobject- Every contact field's value, by the field's alias, such as city
first_nametext- First name
idnumber- The contact's ID
last_activetext- When it was last active (ISO 8601)
last_nametext- Last name
linktext- A link to it in Mautic
mobiletext- Mobile number
ownertext- The Mautic user who owns it
phonetext- Phone number
pointsnumber- Its points
stagetext- The stage it's in; blank for none
tagslist- Its tags
unsubscribedtrue/false- True when it mustn't be sent email (Do Not Contact)
Example output
{
"company": "Analytical Engines",
"date_added": "2026-10-20T09:00:00+00:00",
"date_identified": "2026-10-20T09:00:00+00:00",
"do_not_contact": [
"email"
],
"email": "ada@example.com",
"fields": {
"city": "London",
"company": "Analytical Engines",
"email": "ada@example.com",
"firstname": "Ada",
"lastname": "Lovelace",
"points": 15
},
"first_name": "Ada",
"id": 42,
"last_active": "2026-10-28T11:02:00+00:00",
"last_name": "Lovelace",
"link": "https://mautic.example.com/s/contacts/view/42",
"mobile": "",
"owner": "Sam Marketer",
"phone": "+44 20 7946 0000",
"points": 15,
"stage": "Lead",
"tags": [
"newsletter",
"webinar"
],
"unsubscribed": true
}