Mautic AdvancedInstall

Summary

Add UTM tracking tags and related metadata to a specified contact in Mautic to attribute campaign traffic and update contact information accordingly.

Inputs

• Authentication — Choose between Credentials or OAuth2 authentication methods for the API request.
• Contact ID (required) — The unique identifier of the contact to which the UTM tags will be added.
• UTM Fields — A collection of optional UTM parameters and related fields to attribute campaign data, including 'utmCampaign', 'utmSource', 'utmMedium', 'utmContent', 'utmTerm', as well as metadata like 'User Agent', 'URL', 'Referer', 'Query', 'Remote Host', and 'Last Active' date. These fields update the contact's tracking information in Mautic.

Output shape

a single updated contact record as returned by the Mautic API

The operation returns the Mautic API's contact data with UTM tags updated. Only the Contact ID is strictly required; other UTM fields are optional. The contact's 'lastActive' date will update if provided. This operation requires proper authentication and will fail if the contact ID is invalid or the API request encounters errors.

Examples

Example 1: Add UTM tags to a contact with specific campaign, source, medium, and set last activity date to attribute traffic

Contact ID provided with utmCampaign='spring_sale', utmSource='newsletter', utmMedium='email', lastActive='2024-04-01T10:00:00Z'.