Mailcoach
mailcoachMailcoach is an email marketing platform that allows users to manage email campaigns and subscriber lists efficiently.
Acciones disponibles (45)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add Mailcoach CampaignMAILCOACH_ADD_CAMPAIGNAcciónTool to create a new mailcoach campaign. use when you need to send or schedule an email campaign to a specific list or segment.
MAILCOACH_ADD_CAMPAIGNAcciónTool to create a new mailcoach campaign. use when you need to send or schedule an email campaign to a specific list or segment.
Parámetros de entrada
htmlstringRaw HTML content for the campaign; if omitted, template_uuid or mailable_class must be provided
namestringObligatorioUnique name for the campaign
fieldsobjectDynamic template fields when using a template UUID.
utm_tagsbooleanWhether to automatically append UTM parameters to all links
schedule_atstringSchedule date/time in 'YYYY-MM-DD HH:MM:SS' (server timezone)
segment_uuidstringUUID of the subscriber segment to target
template_uuidstringUUID of the template; required if using a saved template
mailable_classstringFully-qualified class name for a custom mailable
disable_webviewbooleanWhether to disable the webview version of the email
email_list_uuidstringObligatorioUUID of the email list to send the campaign to
add_subscriber_tagsbooleanWhether to add subscriber-specific tags found in the content
add_subscriber_link_tagsbooleanWhether to add link tags for each subscriber
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Email ListMAILCOACH_ADD_EMAIL_LISTAcciónTool to create a new email list. use when you need to manage and organize subscribers before sending campaigns. use after authentication.
MAILCOACH_ADD_EMAIL_LISTAcciónTool to create a new email list. use when you need to manage and organize subscribers before sending campaigns. use after authentication.
Parámetros de entrada
namestringObligatorioEmail list name
campaign_mailerstringMailer for campaigns, as defined in the Laravel config
automation_mailerstringMailer for automations, as defined in the Laravel config
confirmation_mailstringenumType of confirmation mail to send
send_default_confirmation_mailsend_custom_confirmation_maildefault_from_namestringDefault sender name
report_recipientsstringComma-separated emails to receive reports
default_from_emailstringObligatorioemailDefault sender email address
report_campaign_sentbooleanSend report after each campaign is sent
transactional_mailerstringMailer for transactional emails, as defined in the Laravel config
default_reply_to_namestringDefault reply-to name
requires_confirmationbooleanRequire double opt-in confirmation for new subscribers
campaigns_feed_enabledbooleanEnable RSS feed for campaigns
default_reply_to_emailstringemailDefault reply-to email address
report_campaign_summarybooleanInclude campaign summary in reports
allow_form_subscriptionsbooleanAllow subscriptions via form
confirmation_mail_contentstringHTML content for custom confirmation mail; required if confirmation_mail is send_custom_confirmation_mail
confirmation_mail_subjectstringSubject for custom confirmation mail; required if confirmation_mail is send_custom_confirmation_mail
redirect_after_subscribedstringURL redirect after a successful subscription
report_email_list_summarybooleanInclude email list summary in reports
redirect_after_unsubscribedstringURL redirect after unsubscribed
allowed_form_subscription_tagsstring[]Allowed tags that subscribers can choose when subscribing via form
redirect_after_already_subscribedstringURL redirect when already subscribed
redirect_after_subscription_pendingstringURL redirect after subscription pending confirmation
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add suppressionMAILCOACH_ADD_SUPPRESSIONAcciónTool to add a suppression entry. use after detecting a bounce, spam complaint, or manual block.
MAILCOACH_ADD_SUPPRESSIONAcciónTool to add a suppression entry. use after detecting a bounce, spam complaint, or manual block.
Parámetros de entrada
emailstringObligatorioThe email address to suppress
reasonstringenumReason for suppression. One of 'hard_bounce', 'spam_complaint', or 'manual'.
hard_bouncespam_complaintmanual
Parámetros de salida
dataobjectObligatorioRepresentation of a suppression entry returned by Mailcoach.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Tag to Email ListMAILCOACH_ADD_TAGAcciónTool to create a new tag within a specific email list. use after confirming the email list exists.
MAILCOACH_ADD_TAGAcciónTool to create a new tag within a specific email list. use after confirming the email list exists.
Parámetros de entrada
namestringObligatorioName of the tag to create
email_list_uuidstringObligatorioUUID of the target email list where the tag will be created
visible_in_preferencesbooleanWhether this tag should be shown in subscriber preference settings. If omitted, defaults to the server's default behavior.
Parámetros de salida
dataobjectObligatorioThe created tag object
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Tags to SubscriberMAILCOACH_ADD_TAGS_TO_SUBSCRIBERAcciónTool to add tags to a subscriber. use after retrieving a subscriber's uuid to segment them.
MAILCOACH_ADD_TAGS_TO_SUBSCRIBERAcciónTool to add tags to a subscriber. use after retrieving a subscriber's uuid to segment them.
Parámetros de entrada
tagsstring[]ObligatorioNon-empty list of tag names to add to the subscriber.
subscriber_uuidstringObligatorioThe UUID of the subscriber to which tags will be added.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add TemplateMAILCOACH_ADD_TEMPLATEAcciónTool to create a new email template. use after preparing template name and optional html content.
MAILCOACH_ADD_TEMPLATEAcciónTool to create a new email template. use after preparing template name and optional html content.
Parámetros de entrada
htmlstringThe template's full HTML content
namestringObligatorioThe template's name
structured_htmlstringStructured HTML content; may be null
Parámetros de salida
dataobjectObligatorioData model for a Mailcoach template.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Transactional Email TemplateMAILCOACH_ADD_TRANSACTIONAL_EMAIL_TEMPLATEAcciónTool to create a new template that can be used for transactional emails.
MAILCOACH_ADD_TRANSACTIONAL_EMAIL_TEMPLATEAcciónTool to create a new template that can be used for transactional emails.
Parámetros de entrada
ccstringDefault 'cc' recipient(s), comma-separated (ignored).
tostringDefault 'to' recipient(s), comma-separated (ignored).
bccstringDefault 'bcc' recipient(s), comma-separated (ignored).
htmlstringHTML content of the template.
namestringObligatorioUnique name for the template.
subjectstringSubject line (ignored when creating general templates).
store_mailbooleanWhether to store sent mails (ignored).
structured_htmlstringStructured HTML content (e.g., MJML).
Parámetros de salida
dataobjectObligatorioData model for a Mailcoach general template.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Append to Subscriber ImportMAILCOACH_APPEND_TO_SUBSCRIBER_IMPORTAcciónTool to append csv data to an existing subscriber import. use after retrieving a subscriber import when additional subscriber data needs to be added.
MAILCOACH_APPEND_TO_SUBSCRIBER_IMPORTAcciónTool to append csv data to an existing subscriber import. use after retrieving a subscriber import when additional subscriber data needs to be added.
Parámetros de entrada
import_uuidstringObligatorioUUID of the subscriber import to append data to.
subscribers_csvstringObligatorioCSV formatted string of subscriber data to append.
Parámetros de salida
dataobjectObligatorioDetails of the updated subscriber import.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Confirm SubscriberMAILCOACH_CONFIRM_SUBSCRIBERAcciónTool to confirm a subscriber’s subscription. use when finalizing the double opt-in process after they have provided subscriber details. example: "confirm subscriber with uuid 123e4567-e89b-12d3-a456-426614174000"
MAILCOACH_CONFIRM_SUBSCRIBERAcciónTool to confirm a subscriber’s subscription. use when finalizing the double opt-in process after they have provided subscriber details. example: "confirm subscriber with uuid 123e4567-e89b-12d3-a456-426614174000"
Parámetros de entrada
subscriber_uuidanyObligatoriouuidUUID of the subscriber to confirm
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Subscriber ImportMAILCOACH_CREATE_SUBSCRIBER_IMPORTAcciónTool to create a new subscriber import. use when you have a prepared csv and want to upload it into an existing mailcoach email list after exporting or generating subscriber data.
MAILCOACH_CREATE_SUBSCRIBER_IMPORTAcciónTool to create a new subscriber import. use when you have a prepared csv and want to upload it into an existing mailcoach email list after exporting or generating subscriber data.
Parámetros de entrada
replace_tagsbooleanObligatorioReplace all existing tags on the subscribers if true.
email_list_uuidstringObligatorioUUID of the target email list.
subscribers_csvstringObligatorioCSV string with subscribers' data, one row per subscriber. Must include header.
unsubscribe_othersbooleanObligatorioUnsubscribe list members not present in the CSV if true.
subscribe_unsubscribedbooleanObligatorioResubscribe previously unsubscribed emails if true.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CampaignMAILCOACH_DELETE_CAMPAIGNAcciónTool to delete a campaign by uuid. use when you need to permanently remove a campaign after confirming its identifier.
MAILCOACH_DELETE_CAMPAIGNAcciónTool to delete a campaign by uuid. use when you need to permanently remove a campaign after confirming its identifier.
Parámetros de entrada
uuidstringObligatoriouuidThe UUID of the campaign to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Email ListMAILCOACH_DELETE_EMAIL_LISTAcciónTool to delete an email list by uuid. use when you need to permanently remove an email list after confirming its identifier.
MAILCOACH_DELETE_EMAIL_LISTAcciónTool to delete an email list by uuid. use when you need to permanently remove an email list after confirming its identifier.
Parámetros de entrada
uuidstringObligatoriouuidThe UUID of the email list to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SendMAILCOACH_DELETE_SENDAcciónTool to delete a sent item by its uuid. use after confirming the send's uuid to permanently remove it.
MAILCOACH_DELETE_SENDAcciónTool to delete a sent item by its uuid. use after confirming the send's uuid to permanently remove it.
Parámetros de entrada
uuidstringObligatorioUUID of the send to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SubscriberMAILCOACH_DELETE_SUBSCRIBERAcciónTool to delete a subscriber by uuid. use when you need to permanently remove a subscriber from the system after verifying their uuid.
MAILCOACH_DELETE_SUBSCRIBERAcciónTool to delete a subscriber by uuid. use when you need to permanently remove a subscriber from the system after verifying their uuid.
Parámetros de entrada
uuidstringObligatoriouuidThe UUID of the subscriber to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Subscriber ImportMAILCOACH_DELETE_SUBSCRIBER_IMPORTAcciónTool to delete a subscriber import by its uuid. use when you need to permanently remove a subscriber import after confirming its identifier.
MAILCOACH_DELETE_SUBSCRIBER_IMPORTAcciónTool to delete a subscriber import by its uuid. use when you need to permanently remove a subscriber import after confirming its identifier.
Parámetros de entrada
uuidstringObligatoriouuidThe UUID of the subscriber import to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SuppressionMAILCOACH_DELETE_SUPPRESSIONAcciónTool to delete a suppression entry by uuid. use when you need to permanently remove a suppression after confirming its identifier.
MAILCOACH_DELETE_SUPPRESSIONAcciónTool to delete a suppression entry by uuid. use when you need to permanently remove a suppression after confirming its identifier.
Parámetros de entrada
suppression_uuidstringObligatorioThe UUID or email identifier of the suppression entry to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Tag from Email ListMAILCOACH_DELETE_TAGAcciónTool to delete a tag from an email list. use when you need to permanently remove a tag after confirming its identifiers.
MAILCOACH_DELETE_TAGAcciónTool to delete a tag from an email list. use when you need to permanently remove a tag after confirming its identifiers.
Parámetros de entrada
uuidstringObligatoriouuidUUID of the tag to delete.
email_list_uuidstringObligatoriouuidUUID of the email list containing the tag.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete TemplateMAILCOACH_DELETE_TEMPLATEAcciónTool to delete a template by uuid. use when you need to permanently remove a template after confirming its uuid.
MAILCOACH_DELETE_TEMPLATEAcciónTool to delete a template by uuid. use when you need to permanently remove a template after confirming its uuid.
Parámetros de entrada
uuidstringObligatoriouuidThe UUID of the template to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Transactional MailMAILCOACH_DELETE_TRANSACTIONAL_MAILAcciónTool to delete a transactional mail by its uuid. use when you need to permanently remove a transactional mail after confirming its uuid.
MAILCOACH_DELETE_TRANSACTIONAL_MAILAcciónTool to delete a transactional mail by its uuid. use when you need to permanently remove a transactional mail after confirming its uuid.
Parámetros de entrada
uuidstringObligatorioUUID of the transactional mail to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All CampaignsMAILCOACH_GET_ALL_CAMPAIGNSAcciónTool to retrieve all campaigns. use when you need a paginated, sortable list of campaigns matching criteria.
MAILCOACH_GET_ALL_CAMPAIGNSAcciónTool to retrieve all campaigns. use when you need a paginated, sortable list of campaigns matching criteria.
Parámetros de entrada
pageintegerPage number for paginated results.
sortstringenumSort field; prefix with '-' for descending. Allowed: name, unique_open_count, unique_click_count, unsubscribe_rate, sent_to_number_of_subscribers, sent.
nameunique_open_countunique_click_countunsubscribe_ratesent_to_number_of_subscriberssentfilter[search]stringSearch term to find campaigns by name (e.g., 'blackfriday').
filter[status]stringenumFilter campaigns by status.
sentscheduleddraftfilter[email_list_id]stringFilter by email list ID.
filter[emailList.uuid]stringFilter by email list UUID.
filter[contentItem.template.uuid]stringFilter by associated template UUID.
Parámetros de salida
dataobject[]ObligatorioList of campaign objects
metaobjectObligatorioPagination metadata
errorstringError if any occurred during the execution of the action
linksobjectObligatorioPagination links
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All Sent ItemsMAILCOACH_GET_ALL_SENT_ITEMSAcciónTool to retrieve all sent items. use when you need to list and filter sent items after delivery.
MAILCOACH_GET_ALL_SENT_ITEMSAcciónTool to retrieve all sent items. use when you need to list and filter sent items after delivery.
Parámetros de entrada
pageintegerPage number for pagination (must be ≥1)
sortstringenumSort by sent_at: '-sent_at' for descending (default), 'sent_at' for ascending
-sent_atsent_atcampaign_uuidstringFilter by campaign UUID
subscriber_uuidstringFilter by subscriber UUID
automation_mail_uuidstringFilter by automation mail UUID
transactional_mail_log_item_uuidstringFilter by transactional mail log item UUID
Parámetros de salida
dataobject[]ObligatorioArray of sent items
metaobjectObligatorioPagination metadata
errorstringError if any occurred during the execution of the action
linksobjectObligatorioPagination links
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All Subscriber ImportsMAILCOACH_GET_ALL_SUBSCRIBER_IMPORTSAcciónTool to retrieve all subscriber imports. use when you need a paginated list of import jobs.
MAILCOACH_GET_ALL_SUBSCRIBER_IMPORTSAcciónTool to retrieve all subscriber imports. use when you need a paginated list of import jobs.
Parámetros de entrada
pageintegerPage number for paginated results (must be ≥ 1)
Parámetros de salida
dataobject[]ObligatorioList of subscriber imports
metaobjectObligatorioPagination metadata
errorstringError if any occurred during the execution of the action
linksobjectObligatorioPagination links
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All SuppressionsMAILCOACH_GET_ALL_SUPPRESSIONSAcciónTool to list all suppression entries. use when you need suppression uuids for further retrieval.
MAILCOACH_GET_ALL_SUPPRESSIONSAcciónTool to list all suppression entries. use when you need suppression uuids for further retrieval.
Parámetros de entrada
pageintegerPage number for paginated results
sortstringSort by created_at; prefix with '-' for descending
filter[reason]stringenumFilter suppressions by reason
hard_bouncespam_complaintmanualfilter[search]stringSearch by full or partial email address
Parámetros de salida
dataobject[]ObligatorioList of suppression entries
metaobjectObligatorioPagination metadata
errorstringError if any occurred during the execution of the action
linksobjectObligatorioPagination links
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All TagsMAILCOACH_GET_ALL_TAGSAcciónTool to retrieve all tags for a specific email list. use after confirming the email list exists.
MAILCOACH_GET_ALL_TAGSAcciónTool to retrieve all tags for a specific email list. use after confirming the email list exists.
Parámetros de entrada
pageintegerPage number for paginated results
email_list_uuidstringObligatorioUUID of the email list to fetch tags for
Parámetros de salida
dataobject[]ObligatorioList of tag objects
metaobjectObligatorioPagination metadata
errorstringError if any occurred during the execution of the action
linksobjectObligatorioPagination links
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All TemplatesMAILCOACH_GET_ALL_TEMPLATESAcciónTool to retrieve all templates. use when you need a paginated list of templates with optional search and sorting.
MAILCOACH_GET_ALL_TEMPLATESAcciónTool to retrieve all templates. use when you need a paginated list of templates with optional search and sorting.
Parámetros de entrada
pageintegerPage number for paginated results (>= 1).
sortstringenumSort field; prefix with '-' for descending. Allowed: 'name', 'updated_at'.
nameupdated_at-name-updated_atfilter[search]stringSearch term to filter templates by name (e.g., 'welcome').
Parámetros de salida
dataobject[]ObligatorioList of template objects
metaobjectObligatorioPagination metadata
errorstringError if any occurred during the execution of the action
linksobjectObligatorioPagination links
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All Transactional Email TemplatesMAILCOACH_GET_ALL_TRANSACTIONAL_EMAIL_TEMPLATESAcciónTool to retrieve all transactional email templates. use when you need a paginated list of transactional templates matching your criteria.
MAILCOACH_GET_ALL_TRANSACTIONAL_EMAIL_TEMPLATESAcciónTool to retrieve all transactional email templates. use when you need a paginated list of transactional templates matching your criteria.
Parámetros de entrada
pageintegerPage number for paginated results.
sortstringenumSort by created_at; prefix with '-' for descending (e.g., '-created_at').
created_at-created_atfilter[name]stringFilter templates by name (e.g., 'welcome_email').
Parámetros de salida
dataobject[]ObligatorioList of transactional email templates
metaobjectObligatorioPagination metadata
errorstringError if any occurred during the execution of the action
linksobjectObligatorioPagination links
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Email ListsMAILCOACH_GET_EMAIL_LISTSAcciónTool to retrieve all email lists. use when you need to fetch a paginated list of email lists with optional filters.
MAILCOACH_GET_EMAIL_LISTSAcciónTool to retrieve all email lists. use when you need to fetch a paginated list of email lists with optional filters.
Parámetros de entrada
pageintegerPage number for paginated results, must be >= 1
sortstringenumSort by one of 'name', 'created_at', or 'active_subscribers_count'; prefix with '-' for descending
name-namecreated_at-created_atactive_subscribers_count-active_subscribers_countfilter[name]stringExact match on list name
filter[search]stringFuzzy search by list name
Parámetros de salida
dataobject[]ObligatorioList of email list objects
metaobjectObligatorioPagination metadata
errorstringError if any occurred during the execution of the action
linksobjectObligatorioPagination links
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Specific CampaignMAILCOACH_GET_SPECIFIC_CAMPAIGNAcciónTool to retrieve details of a specific mailcoach campaign. use when you need the full campaign resource by its uuid.
MAILCOACH_GET_SPECIFIC_CAMPAIGNAcciónTool to retrieve details of a specific mailcoach campaign. use when you need the full campaign resource by its uuid.
Parámetros de entrada
uuidstringObligatorioUUID of the campaign to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Specific Email ListMAILCOACH_GET_SPECIFIC_EMAIL_LISTAcciónTool to retrieve a specific email list. use when you need to fetch details by uuid.
MAILCOACH_GET_SPECIFIC_EMAIL_LISTAcciónTool to retrieve a specific email list. use when you need to fetch details by uuid.
Parámetros de entrada
uuidstringObligatoriouuidThe UUID of the email list to retrieve.
Parámetros de salida
dataobjectObligatorioEmail list resource
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Specific SubscriberMAILCOACH_GET_SPECIFIC_SUBSCRIBERAcciónTool to retrieve a specific subscriber. use when you need to fetch subscriber details by uuid.
MAILCOACH_GET_SPECIFIC_SUBSCRIBERAcciónTool to retrieve a specific subscriber. use when you need to fetch subscriber details by uuid.
Parámetros de entrada
uuidstringObligatoriouuidThe UUID of the subscriber to retrieve.
Parámetros de salida
dataobjectObligatorioSubscriber resource.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Specific SuppressionMAILCOACH_GET_SPECIFIC_SUPPRESSIONAcciónTool to retrieve a specific suppression entry. use when you need to fetch suppression details by uuid or email.
MAILCOACH_GET_SPECIFIC_SUPPRESSIONAcciónTool to retrieve a specific suppression entry. use when you need to fetch suppression details by uuid or email.
Parámetros de entrada
suppression_uuidstringObligatorioThe UUID or email identifier of the suppression entry to retrieve.
Parámetros de salida
dataobjectObligatorioSuppression resource
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Specific TagMAILCOACH_GET_SPECIFIC_TAGAcciónTool to retrieve details of a specific tag. use when you need to fetch tag metadata after confirming the email list and tag uuids.
MAILCOACH_GET_SPECIFIC_TAGAcciónTool to retrieve details of a specific tag. use when you need to fetch tag metadata after confirming the email list and tag uuids.
Parámetros de entrada
uuidstringObligatoriouuidUUID of the tag to retrieve.
email_list_uuidstringObligatoriouuidUUID of the email list owning the tag.
Parámetros de salida
dataobjectObligatorioThe requested tag resource
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Specific TemplateMAILCOACH_GET_SPECIFIC_TEMPLATEAcciónTool to retrieve details of a specific template. use when you need template information by uuid.
MAILCOACH_GET_SPECIFIC_TEMPLATEAcciónTool to retrieve details of a specific template. use when you need template information by uuid.
Parámetros de entrada
uuidstringObligatoriouuidThe UUID of the template to retrieve.
Parámetros de salida
dataobjectObligatorioTemplate resource
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Transactional MailsMAILCOACH_GET_TRANSACTIONAL_MAILSAcciónTool to retrieve all transactional mail templates. use when you need a paginated list of transactional mails.
MAILCOACH_GET_TRANSACTIONAL_MAILSAcciónTool to retrieve all transactional mail templates. use when you need a paginated list of transactional mails.
Parámetros de entrada
pageintegerPage number for paginated results (must be >=1).
sortstringenumSort by created_at; prefix with '-' for descending.
created_at-created_atfilter[name]stringFilter templates by name (e.g., 'welcome_email').
Parámetros de salida
dataobject[]ObligatorioList of transactional mail templates
metaobjectObligatorioPagination metadata
errorstringError if any occurred during the execution of the action
linksobjectObligatorioPagination links
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove Tags from SubscriberMAILCOACH_REMOVE_TAGS_FROM_SUBSCRIBERAcciónTool to remove tags from a subscriber. use after retrieving a subscriber's uuid to adjust their segments.
MAILCOACH_REMOVE_TAGS_FROM_SUBSCRIBERAcciónTool to remove tags from a subscriber. use after retrieving a subscriber's uuid to adjust their segments.
Parámetros de entrada
tagsstring[]ObligatorioNon-empty list of tag names to remove from the subscriber.
subscriber_uuidstringObligatorioThe UUID of the subscriber from whom tags will be removed.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Resend Subscriber ConfirmationMAILCOACH_RESEND_CONFIRMATIONAcciónTool to resend confirmation email to a subscriber. use when a subscriber hasn't confirmed and you need to resend the confirmation.
MAILCOACH_RESEND_CONFIRMATIONAcciónTool to resend confirmation email to a subscriber. use when a subscriber hasn't confirmed and you need to resend the confirmation.
Parámetros de entrada
uuidstringObligatoriouuidThe UUID of the subscriber to resend the confirmation email to.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Start Subscriber ImportMAILCOACH_START_SUBSCRIBER_IMPORTAcciónTool to start processing a subscriber import. use when you have a draft subscriber import ready to be processed.
MAILCOACH_START_SUBSCRIBER_IMPORTAcciónTool to start processing a subscriber import. use when you have a draft subscriber import ready to be processed.
Parámetros de entrada
uuidstringObligatoriouuidUUID of the subscriber import to start.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Subscribe To Email ListMAILCOACH_SUBSCRIBE_TO_EMAIL_LISTAcciónTool to add or update a subscriber in an email list. use when you have subscriber details and need to subscribe them to a specific list, optionally skipping confirmation or enforcing strict mode.
MAILCOACH_SUBSCRIBE_TO_EMAIL_LISTAcciónTool to add or update a subscriber in an email list. use when you have subscriber details and need to subscribe them to a specific list, optionally skipping confirmation or enforcing strict mode.
Parámetros de entrada
tagsstring[]Tags to set; passing tags will sync/replace tags on the subscriber (optional)
emailstringObligatorioemailSubscriber's email address
strictbooleanIf true and the email already exists, the call fails instead of updating (optional)
last_namestringSubscriber's last name (optional)
first_namestringSubscriber's first name (optional)
email_list_uuidstringObligatorioUUID of the email list to add the subscriber to
extra_attributesobjectCustom fields as key-value pairs (optional, values must be strings)
skip_confirmationbooleanSkip double opt-in; immediately confirm the subscription (optional)
Parámetros de salida
dataobjectObligatorioData model for a Mailcoach subscriber resource.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unsubscribe SubscriberMAILCOACH_UNSUBSCRIBE_SUBSCRIBERAcciónTool to unsubscribe a subscriber from an email list. use when removing a subscriber upon their request after confirming details. example: "unsubscribe subscriber with uuid 123e4567-e89b-12d3-a456-426614174000"
MAILCOACH_UNSUBSCRIBE_SUBSCRIBERAcciónTool to unsubscribe a subscriber from an email list. use when removing a subscriber upon their request after confirming details. example: "unsubscribe subscriber with uuid 123e4567-e89b-12d3-a456-426614174000"
Parámetros de entrada
subscriber_uuidanyObligatoriouuidUUID of the subscriber to unsubscribe
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update CampaignMAILCOACH_UPDATE_CAMPAIGNAcciónTool to update an existing mailcoach campaign. use after identifying the campaign uuid when you need to modify campaign attributes such as name, schedule, or content.
MAILCOACH_UPDATE_CAMPAIGNAcciónTool to update an existing mailcoach campaign. use after identifying the campaign uuid when you need to modify campaign attributes such as name, schedule, or content.
Parámetros de entrada
htmlstringRaw HTML content of the campaign
namestringObligatorioNew name for the campaign
uuidstringObligatorioUUID of the campaign to update
fieldsobjectKey-value pairs to merge into dynamic template fields
contentstringMarkdown content if using a markdown-enabled template
subjectstringOverride email subject line
utm_tagsbooleanAppend UTM tags to all links
from_namestringOverride 'from' display name
from_emailstringOverride 'from' email address
schedule_atstringScheduled send datetime in 'YYYY-MM-DD HH:MM:SS' (server timezone)
segment_uuidstringUUID of a subscriber segment to target
template_uuidstringUUID of the template to use; omit to keep current template
mailable_classstringFully-qualified class name for a custom mailable
disable_webviewbooleanDisable public webview generation
email_list_uuidstringObligatorioUUID of the email list to send the campaign to
add_subscriber_tagsbooleanTag subscribers after send
add_subscriber_link_tagsbooleanTag clicked links per subscriber
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Email ListMAILCOACH_UPDATE_EMAIL_LISTAcciónTool to update an existing email list. use when you need to modify a list's configuration after verifying its uuid.
MAILCOACH_UPDATE_EMAIL_LISTAcciónTool to update an existing email list. use when you need to modify a list's configuration after verifying its uuid.
Parámetros de entrada
namestringObligatorioEmail list name
uuidstringObligatoriouuidThe UUID of the email list to update
campaign_mailerstringMailer for campaigns, as defined in the Laravel config
automation_mailerstringMailer for automations, as defined in the Laravel config
confirmation_mailstringenumType of confirmation mail to send
send_default_confirmation_mailsend_custom_confirmation_maildefault_from_namestringDefault sender name
report_recipientsstringComma-separated emails to receive reports
default_from_emailstringObligatorioemailDefault sender email address
report_campaign_sentbooleanSend report after each campaign is sent
transactional_mailerstringMailer for transactional emails, as defined in the Laravel config
default_reply_to_namestringDefault reply-to name
requires_confirmationbooleanRequire double opt-in confirmation for new subscribers
campaigns_feed_enabledbooleanEnable RSS feed for campaigns
default_reply_to_emailstringemailDefault reply-to email address
report_campaign_summarybooleanInclude campaign summary in reports
allow_form_subscriptionsbooleanAllow subscriptions via form
confirmation_mail_contentstringHTML content for custom confirmation mail; required if confirmation_mail is 'send_custom_confirmation_mail'
confirmation_mail_subjectstringSubject for custom confirmation mail; required if confirmation_mail is 'send_custom_confirmation_mail'
redirect_after_subscribedstringURL redirect after a successful subscription
report_email_list_summarybooleanInclude email list summary in reports
redirect_after_unsubscribedstringURL redirect after unsubscribed
allowed_form_subscription_tagsstring[]Allowed tags that subscribers can choose when subscribing via form
redirect_after_already_subscribedstringURL redirect when already subscribed
redirect_after_subscription_pendingstringURL redirect after subscription pending confirmation
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update SubscriberMAILCOACH_UPDATE_SUBSCRIBERAcciónTool to update a subscriber. use when you need to modify subscriber details after creation.
MAILCOACH_UPDATE_SUBSCRIBERAcciónTool to update a subscriber. use when you need to modify subscriber details after creation.
Parámetros de entrada
tagsstring[]Tags to set; replaces existing tags by default.
emailstringObligatorioThe subscriber’s email address.
last_namestringSubscriber’s last name. Set to null to remove.
first_namestringSubscriber’s first name. Set to null to remove.
append_tagsbooleanIf true, provided tags are appended instead of replaced.
subscriber_uuidstringObligatoriouuidUUID of the subscriber to update.
extra_attributesobjectAdditional custom attributes for the subscriber.
Parámetros de salida
dataobjectObligatorioUpdated subscriber resource.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Subscriber ImportMAILCOACH_UPDATE_SUBSCRIBER_IMPORTAcciónTool to update an existing subscriber import. use when you need to modify a draft import before execution. import must be in draft status.
MAILCOACH_UPDATE_SUBSCRIBER_IMPORTAcciónTool to update an existing subscriber import. use when you need to modify a draft import before execution. import must be in draft status.
Parámetros de entrada
import_uuidstringObligatorioUUID of the subscriber import to update.
replace_tagsbooleanObligatorioReplace all existing tags on the subscribers if true.
email_list_uuidstringObligatorioUUID of the target email list.
subscribers_csvstringObligatorioCSV string with subscribers' data, one row per subscriber. Must include header.
unsubscribe_othersbooleanObligatorioUnsubscribe list members not present in the CSV if true.
subscribe_unsubscribedbooleanObligatorioResubscribe previously unsubscribed emails if true.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update TagMAILCOACH_UPDATE_TAGAcciónTool to update an existing tag within an email list. use when you need to modify the name or visibility of a tag after verifying its existence.
MAILCOACH_UPDATE_TAGAcciónTool to update an existing tag within an email list. use when you need to modify the name or visibility of a tag after verifying its existence.
Parámetros de entrada
namestringObligatorioNew name for the tag
uuidstringObligatoriouuidUUID of the tag to update
email_list_uuidstringObligatoriouuidUUID of the email list containing the tag
visible_in_preferencesbooleanWhether this tag should be shown in subscriber preference settings
Parámetros de salida
dataobjectObligatorioThe updated tag resource
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update TemplateMAILCOACH_UPDATE_TEMPLATEAcciónTool to update an existing template's name or content. use when you need to modify a template's html or structured html by its uuid.
MAILCOACH_UPDATE_TEMPLATEAcciónTool to update an existing template's name or content. use when you need to modify a template's html or structured html by its uuid.
Parámetros de entrada
htmlstringThe template's new full HTML content
namestringObligatorioThe template's new name
uuidstringObligatoriouuidUUID of the template to update
structured_htmlstringStructured HTML content; may be null to clear
Parámetros de salida
dataobjectObligatorioData model for a Mailcoach template.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not