Skip to main content

create_campaign

Facts​

DescriptionCreate an email campaign
SchemaConnectors.Mailchimp.functions.CreateCampaign
ServiceMailchimp

Input parameters​

Required input parameters

audience_idstringRequired

The ID of the audience to associate with this campaign

Examples
1234567890
campaign_titlestringRequired

Campaign title

Examples
Developer newsletter
from_namestringRequired

The 'from' name on a campaign (not an email address)

Examples
Developer Marketing
mailchimp_access_tokenslack#/types/credential/oauth2Required

Mailchimp access token. See the authentication section for details.

preview_textstringRequired

The preview text for the campaign

Examples
We've released another version of our developer tools.
reply_tostringRequired

The reply-to email address for the campaign.

Examples
replies@devrel.trailblazers.salesforce.tld
subject_linestringRequired

The subject line for the campaign

Examples
Developer's Monthly Newsletter

Output parameters​

Optional output parameters

idstringOptional

Campaign ID

statusstringOptional

Campaign status

urlstringOptional

Campaign URL

Authentication​

End-user authentication

User workflows that include a connector function relying on end-user authentication can only be started with a link trigger.

{
  "mailchimp_access_token": {
    "credential_source": "END_USER"
  }
}

End-user experience: User will be prompted to link their external account via OAuth when they first start the workflow that contains this connector.

Developer experience: Developer does not have to implement authentication in the app.

Usage info​

First, import Connectors from deno-slack-hub into your project's import_map.json file, like this:

import_map.json
{
    "imports": {
      "deno-slack-hub/": "https://deno.land/x/deno_slack_hub@2.2.0/",
      "deno-slack-sdk/": "https://deno.land/x/deno_slack_sdk@2.14.2/",
      "deno-slack-api/": "https://deno.land/x/deno_slack_api@2.8.0/"
    }
  }

Next, import Connectors at the top of your workflow's definition file:

my_workflow_file.ts
import { Connectors } from "deno-slack-hub/mod.ts";

Finally, add the connector as a step in your workflow just like you would a Slack function.

my_workflow_file.ts
SomeWorkflow.addStep(
  Connectors.Mailchimp.functions.CreateCampaign, {
  //...

🧙🏼 Your admin may need to approve the connector first. If your workspace has been configured to only allow admin-approved apps, the CLI will prompt you to send an admin approval request the first time you try to use a connector that hasn't been approved by an admin yet. While waiting for admin approval, the CLI may report an error like this:

Workflow function X is referring to an unknown step output parameter Y

You can safely ignore this error; it will go away as soon as your workspace admin approves your request to use the connector.