NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Mailcoach

mailcoach

Mailcoach is an email marketing platform that allows users to manage email campaigns and subscriber lists efficiently.

Email NewslettersMarketing AutomationWeb del proveedor
Acciones
45
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool 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

  • htmlstring

    Raw HTML content for the campaign; if omitted, template_uuid or mailable_class must be provided

  • namestringObligatorio

    Unique name for the campaign

  • fieldsobject

    Dynamic template fields when using a template UUID.

  • utm_tagsboolean

    Whether to automatically append UTM parameters to all links

  • schedule_atstring

    Schedule date/time in 'YYYY-MM-DD HH:MM:SS' (server timezone)

  • segment_uuidstring

    UUID of the subscriber segment to target

  • template_uuidstring

    UUID of the template; required if using a saved template

  • mailable_classstring

    Fully-qualified class name for a custom mailable

  • disable_webviewboolean

    Whether to disable the webview version of the email

  • email_list_uuidstringObligatorio

    UUID of the email list to send the campaign to

  • add_subscriber_tagsboolean

    Whether to add subscriber-specific tags found in the content

  • add_subscriber_link_tagsboolean

    Whether to add link tags for each subscriber

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add Email ListMAILCOACH_ADD_EMAIL_LISTAcción

Tool 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

  • namestringObligatorio

    Email list name

  • campaign_mailerstring

    Mailer for campaigns, as defined in the Laravel config

  • automation_mailerstring

    Mailer for automations, as defined in the Laravel config

  • confirmation_mailstringenum

    Type of confirmation mail to send

    send_default_confirmation_mailsend_custom_confirmation_mail
  • default_from_namestring

    Default sender name

  • report_recipientsstring

    Comma-separated emails to receive reports

  • default_from_emailstringObligatorioemail

    Default sender email address

  • report_campaign_sentboolean

    Send report after each campaign is sent

  • transactional_mailerstring

    Mailer for transactional emails, as defined in the Laravel config

  • default_reply_to_namestring

    Default reply-to name

  • requires_confirmationboolean

    Require double opt-in confirmation for new subscribers

  • campaigns_feed_enabledboolean

    Enable RSS feed for campaigns

  • default_reply_to_emailstringemail

    Default reply-to email address

  • report_campaign_summaryboolean

    Include campaign summary in reports

  • allow_form_subscriptionsboolean

    Allow subscriptions via form

  • confirmation_mail_contentstring

    HTML content for custom confirmation mail; required if confirmation_mail is send_custom_confirmation_mail

  • confirmation_mail_subjectstring

    Subject for custom confirmation mail; required if confirmation_mail is send_custom_confirmation_mail

  • redirect_after_subscribedstring

    URL redirect after a successful subscription

  • report_email_list_summaryboolean

    Include email list summary in reports

  • redirect_after_unsubscribedstring

    URL redirect after unsubscribed

  • allowed_form_subscription_tagsstring[]

    Allowed tags that subscribers can choose when subscribing via form

  • redirect_after_already_subscribedstring

    URL redirect when already subscribed

  • redirect_after_subscription_pendingstring

    URL redirect after subscription pending confirmation

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add suppressionMAILCOACH_ADD_SUPPRESSIONAcción

Tool to add a suppression entry. use after detecting a bounce, spam complaint, or manual block.

Parámetros de entrada

  • emailstringObligatorio

    The email address to suppress

  • reasonstringenum

    Reason for suppression. One of 'hard_bounce', 'spam_complaint', or 'manual'.

    hard_bouncespam_complaintmanual

Parámetros de salida

  • dataobjectObligatorio

    Representation of a suppression entry returned by Mailcoach.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add Tag to Email ListMAILCOACH_ADD_TAGAcción

Tool to create a new tag within a specific email list. use after confirming the email list exists.

Parámetros de entrada

  • namestringObligatorio

    Name of the tag to create

  • email_list_uuidstringObligatorio

    UUID of the target email list where the tag will be created

  • visible_in_preferencesboolean

    Whether this tag should be shown in subscriber preference settings. If omitted, defaults to the server's default behavior.

Parámetros de salida

  • dataobjectObligatorio

    The created tag object

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add Tags to SubscriberMAILCOACH_ADD_TAGS_TO_SUBSCRIBERAcción

Tool to add tags to a subscriber. use after retrieving a subscriber's uuid to segment them.

Parámetros de entrada

  • tagsstring[]Obligatorio

    Non-empty list of tag names to add to the subscriber.

  • subscriber_uuidstringObligatorio

    The UUID of the subscriber to which tags will be added.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add TemplateMAILCOACH_ADD_TEMPLATEAcción

Tool to create a new email template. use after preparing template name and optional html content.

Parámetros de entrada

  • htmlstring

    The template's full HTML content

  • namestringObligatorio

    The template's name

  • structured_htmlstring

    Structured HTML content; may be null

Parámetros de salida

  • dataobjectObligatorio

    Data model for a Mailcoach template.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add Transactional Email TemplateMAILCOACH_ADD_TRANSACTIONAL_EMAIL_TEMPLATEAcción

Tool to create a new template that can be used for transactional emails.

Parámetros de entrada

  • ccstring

    Default 'cc' recipient(s), comma-separated (ignored).

  • tostring

    Default 'to' recipient(s), comma-separated (ignored).

  • bccstring

    Default 'bcc' recipient(s), comma-separated (ignored).

  • htmlstring

    HTML content of the template.

  • namestringObligatorio

    Unique name for the template.

  • subjectstring

    Subject line (ignored when creating general templates).

  • store_mailboolean

    Whether to store sent mails (ignored).

  • structured_htmlstring

    Structured HTML content (e.g., MJML).

Parámetros de salida

  • dataobjectObligatorio

    Data model for a Mailcoach general template.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Append to Subscriber ImportMAILCOACH_APPEND_TO_SUBSCRIBER_IMPORTAcción

Tool 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_uuidstringObligatorio

    UUID of the subscriber import to append data to.

  • subscribers_csvstringObligatorio

    CSV formatted string of subscriber data to append.

Parámetros de salida

  • dataobjectObligatorio

    Details of the updated subscriber import.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Confirm SubscriberMAILCOACH_CONFIRM_SUBSCRIBERAcción

Tool 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_uuidanyObligatoriouuid

    UUID of the subscriber to confirm

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Subscriber ImportMAILCOACH_CREATE_SUBSCRIBER_IMPORTAcción

Tool 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_tagsbooleanObligatorio

    Replace all existing tags on the subscribers if true.

  • email_list_uuidstringObligatorio

    UUID of the target email list.

  • subscribers_csvstringObligatorio

    CSV string with subscribers' data, one row per subscriber. Must include header.

  • unsubscribe_othersbooleanObligatorio

    Unsubscribe list members not present in the CSV if true.

  • subscribe_unsubscribedbooleanObligatorio

    Resubscribe previously unsubscribed emails if true.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete CampaignMAILCOACH_DELETE_CAMPAIGNAcción

Tool to delete a campaign by uuid. use when you need to permanently remove a campaign after confirming its identifier.

Parámetros de entrada

  • uuidstringObligatoriouuid

    The UUID of the campaign to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Email ListMAILCOACH_DELETE_EMAIL_LISTAcción

Tool 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

  • uuidstringObligatoriouuid

    The UUID of the email list to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete SendMAILCOACH_DELETE_SENDAcción

Tool to delete a sent item by its uuid. use after confirming the send's uuid to permanently remove it.

Parámetros de entrada

  • uuidstringObligatorio

    UUID of the send to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete SubscriberMAILCOACH_DELETE_SUBSCRIBERAcción

Tool 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

  • uuidstringObligatoriouuid

    The UUID of the subscriber to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Subscriber ImportMAILCOACH_DELETE_SUBSCRIBER_IMPORTAcción

Tool 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

  • uuidstringObligatoriouuid

    The UUID of the subscriber import to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete SuppressionMAILCOACH_DELETE_SUPPRESSIONAcción

Tool 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_uuidstringObligatorio

    The UUID or email identifier of the suppression entry to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Tag from Email ListMAILCOACH_DELETE_TAGAcción

Tool 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

  • uuidstringObligatoriouuid

    UUID of the tag to delete.

  • email_list_uuidstringObligatoriouuid

    UUID of the email list containing the tag.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete TemplateMAILCOACH_DELETE_TEMPLATEAcción

Tool to delete a template by uuid. use when you need to permanently remove a template after confirming its uuid.

Parámetros de entrada

  • uuidstringObligatoriouuid

    The UUID of the template to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Transactional MailMAILCOACH_DELETE_TRANSACTIONAL_MAILAcción

Tool 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

  • uuidstringObligatorio

    UUID of the transactional mail to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All CampaignsMAILCOACH_GET_ALL_CAMPAIGNSAcción

Tool to retrieve all campaigns. use when you need a paginated, sortable list of campaigns matching criteria.

Parámetros de entrada

  • pageinteger

    Page number for paginated results.

  • sortstringenum

    Sort 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_subscriberssent
  • filter[search]string

    Search term to find campaigns by name (e.g., 'blackfriday').

  • filter[status]stringenum

    Filter campaigns by status.

    sentscheduleddraft
  • filter[email_list_id]string

    Filter by email list ID.

  • filter[emailList.uuid]string

    Filter by email list UUID.

  • filter[contentItem.template.uuid]string

    Filter by associated template UUID.

Parámetros de salida

  • dataobject[]Obligatorio

    List of campaign objects

  • metaobjectObligatorio

    Pagination metadata

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All Sent ItemsMAILCOACH_GET_ALL_SENT_ITEMSAcción

Tool to retrieve all sent items. use when you need to list and filter sent items after delivery.

Parámetros de entrada

  • pageinteger

    Page number for pagination (must be ≥1)

  • sortstringenum

    Sort by sent_at: '-sent_at' for descending (default), 'sent_at' for ascending

    -sent_atsent_at
  • campaign_uuidstring

    Filter by campaign UUID

  • subscriber_uuidstring

    Filter by subscriber UUID

  • automation_mail_uuidstring

    Filter by automation mail UUID

  • transactional_mail_log_item_uuidstring

    Filter by transactional mail log item UUID

Parámetros de salida

  • dataobject[]Obligatorio

    Array of sent items

  • metaobjectObligatorio

    Pagination metadata

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All Subscriber ImportsMAILCOACH_GET_ALL_SUBSCRIBER_IMPORTSAcción

Tool to retrieve all subscriber imports. use when you need a paginated list of import jobs.

Parámetros de entrada

  • pageinteger

    Page number for paginated results (must be ≥ 1)

Parámetros de salida

  • dataobject[]Obligatorio

    List of subscriber imports

  • metaobjectObligatorio

    Pagination metadata

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All SuppressionsMAILCOACH_GET_ALL_SUPPRESSIONSAcción

Tool to list all suppression entries. use when you need suppression uuids for further retrieval.

Parámetros de entrada

  • pageinteger

    Page number for paginated results

  • sortstring

    Sort by created_at; prefix with '-' for descending

  • filter[reason]stringenum

    Filter suppressions by reason

    hard_bouncespam_complaintmanual
  • filter[search]string

    Search by full or partial email address

Parámetros de salida

  • dataobject[]Obligatorio

    List of suppression entries

  • metaobjectObligatorio

    Pagination metadata

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All TagsMAILCOACH_GET_ALL_TAGSAcción

Tool to retrieve all tags for a specific email list. use after confirming the email list exists.

Parámetros de entrada

  • pageinteger

    Page number for paginated results

  • email_list_uuidstringObligatorio

    UUID of the email list to fetch tags for

Parámetros de salida

  • dataobject[]Obligatorio

    List of tag objects

  • metaobjectObligatorio

    Pagination metadata

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All TemplatesMAILCOACH_GET_ALL_TEMPLATESAcción

Tool to retrieve all templates. use when you need a paginated list of templates with optional search and sorting.

Parámetros de entrada

  • pageinteger

    Page number for paginated results (>= 1).

  • sortstringenum

    Sort field; prefix with '-' for descending. Allowed: 'name', 'updated_at'.

    nameupdated_at-name-updated_at
  • filter[search]string

    Search term to filter templates by name (e.g., 'welcome').

Parámetros de salida

  • dataobject[]Obligatorio

    List of template objects

  • metaobjectObligatorio

    Pagination metadata

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All Transactional Email TemplatesMAILCOACH_GET_ALL_TRANSACTIONAL_EMAIL_TEMPLATESAcción

Tool to retrieve all transactional email templates. use when you need a paginated list of transactional templates matching your criteria.

Parámetros de entrada

  • pageinteger

    Page number for paginated results.

  • sortstringenum

    Sort by created_at; prefix with '-' for descending (e.g., '-created_at').

    created_at-created_at
  • filter[name]string

    Filter templates by name (e.g., 'welcome_email').

Parámetros de salida

  • dataobject[]Obligatorio

    List of transactional email templates

  • metaobjectObligatorio

    Pagination metadata

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Email ListsMAILCOACH_GET_EMAIL_LISTSAcción

Tool to retrieve all email lists. use when you need to fetch a paginated list of email lists with optional filters.

Parámetros de entrada

  • pageinteger

    Page number for paginated results, must be >= 1

  • sortstringenum

    Sort by one of 'name', 'created_at', or 'active_subscribers_count'; prefix with '-' for descending

    name-namecreated_at-created_atactive_subscribers_count-active_subscribers_count
  • filter[name]string

    Exact match on list name

  • filter[search]string

    Fuzzy search by list name

Parámetros de salida

  • dataobject[]Obligatorio

    List of email list objects

  • metaobjectObligatorio

    Pagination metadata

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Specific CampaignMAILCOACH_GET_SPECIFIC_CAMPAIGNAcción

Tool to retrieve details of a specific mailcoach campaign. use when you need the full campaign resource by its uuid.

Parámetros de entrada

  • uuidstringObligatorio

    UUID of the campaign to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Specific Email ListMAILCOACH_GET_SPECIFIC_EMAIL_LISTAcción

Tool to retrieve a specific email list. use when you need to fetch details by uuid.

Parámetros de entrada

  • uuidstringObligatoriouuid

    The UUID of the email list to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Email list resource

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Specific SubscriberMAILCOACH_GET_SPECIFIC_SUBSCRIBERAcción

Tool to retrieve a specific subscriber. use when you need to fetch subscriber details by uuid.

Parámetros de entrada

  • uuidstringObligatoriouuid

    The UUID of the subscriber to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Subscriber resource.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Specific SuppressionMAILCOACH_GET_SPECIFIC_SUPPRESSIONAcción

Tool to retrieve a specific suppression entry. use when you need to fetch suppression details by uuid or email.

Parámetros de entrada

  • suppression_uuidstringObligatorio

    The UUID or email identifier of the suppression entry to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Suppression resource

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Specific TagMAILCOACH_GET_SPECIFIC_TAGAcción

Tool 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

  • uuidstringObligatoriouuid

    UUID of the tag to retrieve.

  • email_list_uuidstringObligatoriouuid

    UUID of the email list owning the tag.

Parámetros de salida

  • dataobjectObligatorio

    The requested tag resource

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Specific TemplateMAILCOACH_GET_SPECIFIC_TEMPLATEAcción

Tool to retrieve details of a specific template. use when you need template information by uuid.

Parámetros de entrada

  • uuidstringObligatoriouuid

    The UUID of the template to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Template resource

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Transactional MailsMAILCOACH_GET_TRANSACTIONAL_MAILSAcción

Tool to retrieve all transactional mail templates. use when you need a paginated list of transactional mails.

Parámetros de entrada

  • pageinteger

    Page number for paginated results (must be >=1).

  • sortstringenum

    Sort by created_at; prefix with '-' for descending.

    created_at-created_at
  • filter[name]string

    Filter templates by name (e.g., 'welcome_email').

Parámetros de salida

  • dataobject[]Obligatorio

    List of transactional mail templates

  • metaobjectObligatorio

    Pagination metadata

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination links

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove Tags from SubscriberMAILCOACH_REMOVE_TAGS_FROM_SUBSCRIBERAcción

Tool to remove tags from a subscriber. use after retrieving a subscriber's uuid to adjust their segments.

Parámetros de entrada

  • tagsstring[]Obligatorio

    Non-empty list of tag names to remove from the subscriber.

  • subscriber_uuidstringObligatorio

    The UUID of the subscriber from whom tags will be removed.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Resend Subscriber ConfirmationMAILCOACH_RESEND_CONFIRMATIONAcción

Tool 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

  • uuidstringObligatoriouuid

    The UUID of the subscriber to resend the confirmation email to.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Start Subscriber ImportMAILCOACH_START_SUBSCRIBER_IMPORTAcción

Tool to start processing a subscriber import. use when you have a draft subscriber import ready to be processed.

Parámetros de entrada

  • uuidstringObligatoriouuid

    UUID of the subscriber import to start.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Subscribe To Email ListMAILCOACH_SUBSCRIBE_TO_EMAIL_LISTAcción

Tool 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)

  • emailstringObligatorioemail

    Subscriber's email address

  • strictboolean

    If true and the email already exists, the call fails instead of updating (optional)

  • last_namestring

    Subscriber's last name (optional)

  • first_namestring

    Subscriber's first name (optional)

  • email_list_uuidstringObligatorio

    UUID of the email list to add the subscriber to

  • extra_attributesobject

    Custom fields as key-value pairs (optional, values must be strings)

  • skip_confirmationboolean

    Skip double opt-in; immediately confirm the subscription (optional)

Parámetros de salida

  • dataobjectObligatorio

    Data model for a Mailcoach subscriber resource.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Unsubscribe SubscriberMAILCOACH_UNSUBSCRIBE_SUBSCRIBERAcción

Tool 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_uuidanyObligatoriouuid

    UUID of the subscriber to unsubscribe

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update CampaignMAILCOACH_UPDATE_CAMPAIGNAcción

Tool 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

  • htmlstring

    Raw HTML content of the campaign

  • namestringObligatorio

    New name for the campaign

  • uuidstringObligatorio

    UUID of the campaign to update

  • fieldsobject

    Key-value pairs to merge into dynamic template fields

  • contentstring

    Markdown content if using a markdown-enabled template

  • subjectstring

    Override email subject line

  • utm_tagsboolean

    Append UTM tags to all links

  • from_namestring

    Override 'from' display name

  • from_emailstring

    Override 'from' email address

  • schedule_atstring

    Scheduled send datetime in 'YYYY-MM-DD HH:MM:SS' (server timezone)

  • segment_uuidstring

    UUID of a subscriber segment to target

  • template_uuidstring

    UUID of the template to use; omit to keep current template

  • mailable_classstring

    Fully-qualified class name for a custom mailable

  • disable_webviewboolean

    Disable public webview generation

  • email_list_uuidstringObligatorio

    UUID of the email list to send the campaign to

  • add_subscriber_tagsboolean

    Tag subscribers after send

  • add_subscriber_link_tagsboolean

    Tag clicked links per subscriber

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Email ListMAILCOACH_UPDATE_EMAIL_LISTAcción

Tool to update an existing email list. use when you need to modify a list's configuration after verifying its uuid.

Parámetros de entrada

  • namestringObligatorio

    Email list name

  • uuidstringObligatoriouuid

    The UUID of the email list to update

  • campaign_mailerstring

    Mailer for campaigns, as defined in the Laravel config

  • automation_mailerstring

    Mailer for automations, as defined in the Laravel config

  • confirmation_mailstringenum

    Type of confirmation mail to send

    send_default_confirmation_mailsend_custom_confirmation_mail
  • default_from_namestring

    Default sender name

  • report_recipientsstring

    Comma-separated emails to receive reports

  • default_from_emailstringObligatorioemail

    Default sender email address

  • report_campaign_sentboolean

    Send report after each campaign is sent

  • transactional_mailerstring

    Mailer for transactional emails, as defined in the Laravel config

  • default_reply_to_namestring

    Default reply-to name

  • requires_confirmationboolean

    Require double opt-in confirmation for new subscribers

  • campaigns_feed_enabledboolean

    Enable RSS feed for campaigns

  • default_reply_to_emailstringemail

    Default reply-to email address

  • report_campaign_summaryboolean

    Include campaign summary in reports

  • allow_form_subscriptionsboolean

    Allow subscriptions via form

  • confirmation_mail_contentstring

    HTML content for custom confirmation mail; required if confirmation_mail is 'send_custom_confirmation_mail'

  • confirmation_mail_subjectstring

    Subject for custom confirmation mail; required if confirmation_mail is 'send_custom_confirmation_mail'

  • redirect_after_subscribedstring

    URL redirect after a successful subscription

  • report_email_list_summaryboolean

    Include email list summary in reports

  • redirect_after_unsubscribedstring

    URL redirect after unsubscribed

  • allowed_form_subscription_tagsstring[]

    Allowed tags that subscribers can choose when subscribing via form

  • redirect_after_already_subscribedstring

    URL redirect when already subscribed

  • redirect_after_subscription_pendingstring

    URL redirect after subscription pending confirmation

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update SubscriberMAILCOACH_UPDATE_SUBSCRIBERAcción

Tool 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.

  • emailstringObligatorio

    The subscriber’s email address.

  • last_namestring

    Subscriber’s last name. Set to null to remove.

  • first_namestring

    Subscriber’s first name. Set to null to remove.

  • append_tagsboolean

    If true, provided tags are appended instead of replaced.

  • subscriber_uuidstringObligatoriouuid

    UUID of the subscriber to update.

  • extra_attributesobject

    Additional custom attributes for the subscriber.

Parámetros de salida

  • dataobjectObligatorio

    Updated subscriber resource.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Subscriber ImportMAILCOACH_UPDATE_SUBSCRIBER_IMPORTAcción

Tool 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_uuidstringObligatorio

    UUID of the subscriber import to update.

  • replace_tagsbooleanObligatorio

    Replace all existing tags on the subscribers if true.

  • email_list_uuidstringObligatorio

    UUID of the target email list.

  • subscribers_csvstringObligatorio

    CSV string with subscribers' data, one row per subscriber. Must include header.

  • unsubscribe_othersbooleanObligatorio

    Unsubscribe list members not present in the CSV if true.

  • subscribe_unsubscribedbooleanObligatorio

    Resubscribe previously unsubscribed emails if true.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update TagMAILCOACH_UPDATE_TAGAcción

Tool 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

  • namestringObligatorio

    New name for the tag

  • uuidstringObligatoriouuid

    UUID of the tag to update

  • email_list_uuidstringObligatoriouuid

    UUID of the email list containing the tag

  • visible_in_preferencesboolean

    Whether this tag should be shown in subscriber preference settings

Parámetros de salida

  • dataobjectObligatorio

    The updated tag resource

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update TemplateMAILCOACH_UPDATE_TEMPLATEAcción

Tool 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

  • htmlstring

    The template's new full HTML content

  • namestringObligatorio

    The template's new name

  • uuidstringObligatoriouuid

    UUID of the template to update

  • structured_htmlstring

    Structured HTML content; may be null to clear

Parámetros de salida

  • dataobjectObligatorio

    Data model for a Mailcoach template.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not