Netzo

🇺🇸 EN

🇪🇸 ES

🇺🇸 EN

🇪🇸 ES

Appearance

On this page
netzo/apis/mailchimpmarketing

Mailchimp Marketing ​

Mailchimp Marketing is an all-in-one marketing platform that helps you manage and talk to your clients, customers, and other interested parties.

  • labels: email-marketing, marketing-automation, email, marketing, crm
  • authentication: apiKey

Usage ​

ts
import { mailchimpmarketing } from 'https://deno.land/x/netzo/apis/mailchimpmarketing/mod.ts'

const { api } = mailchimpmarketing({
  marketingApiKey: Deno.env.get('MAILCHIMP_MARKETING_API_KEY'),
  dataCenter: Deno.env.get('MAILCHIMP_DATA_CENTER'),
})
import { mailchimpmarketing } from 'https://deno.land/x/netzo/apis/mailchimpmarketing/mod.ts'

const { api } = mailchimpmarketing({
  marketingApiKey: Deno.env.get('MAILCHIMP_MARKETING_API_KEY'),
  dataCenter: Deno.env.get('MAILCHIMP_DATA_CENTER'),
})

Configuration ​

The mailchimpmarketing factory function expects an object with the following, and returns an object with an HTTP client api.

ParamTypeDefaultDescription
marketingApiKeystringDeno.env.get('MAILCHIMP_MARKETING_API_KEY')the api key to use for authentication
dataCenterstringDeno.env.get('MAILCHIMP_DATA_CENTER')the data center for your account

Refer to the API documentation to get the required information.

Examples ​

The following examples assume you have created an api client instance. Refer to the type definitions for all exported types to pass to the api client for typed responses.

Find campaigns ​

Find all campaigns that match the query.

ts
import type { Campaigns, QueryCampaigns } from 'netzo/apis/mailchimpmarketing/types.ts'

const query: QueryCampaigns = {}
const result = await api.campaigns.get<Campaigns>(query)
const resultData = result.campaigns
import type { Campaigns, QueryCampaigns } from 'netzo/apis/mailchimpmarketing/types.ts'

const query: QueryCampaigns = {}
const result = await api.campaigns.get<Campaigns>(query)
const resultData = result.campaigns

Get campaign ​

Get a campaign by id.

ts
import type { Campaign, QueryCampaign } from 'netzo/apis/mailchimpmarketing/types.ts'

const query: QueryCampaign = {}
const resultData = await api.campaigns[CAMPAIGN_ID].get<Campaign>(query)
import type { Campaign, QueryCampaign } from 'netzo/apis/mailchimpmarketing/types.ts'

const query: QueryCampaign = {}
const resultData = await api.campaigns[CAMPAIGN_ID].get<Campaign>(query)

Get campaign content ​

Get the content of a campaign by id.

ts
import type { CampaignContent, QueryCampaign } from 'netzo/apis/mailchimpmarketing/types.ts'

const query: QueryCampaign = {}
const resultData = await api.campaigns[CAMPAIGN_ID].content.get<CampaignContent>(query)
import type { CampaignContent, QueryCampaign } from 'netzo/apis/mailchimpmarketing/types.ts'

const query: QueryCampaign = {}
const resultData = await api.campaigns[CAMPAIGN_ID].content.get<CampaignContent>(query)

Update campaign content ​

Set the content of a campaign by id.

ts
import type { CampaignContent, DataUpdateCampaignContent } from 'netzo/apis/mailchimpmarketing/types.ts'

const data: DataUpdateCampaignContent = { url: '[email protected]' }
const resultData = await api.campaigns[CAMPAIGN_ID].content.put<CampaignContent>(data)
import type { CampaignContent, DataUpdateCampaignContent } from 'netzo/apis/mailchimpmarketing/types.ts'

const data: DataUpdateCampaignContent = { url: '[email protected]' }
const resultData = await api.campaigns[CAMPAIGN_ID].content.put<CampaignContent>(data)

Schedule campaign ​

Schedule a campaign for delivery.

ts
import type { DataScheduleCampaign } from 'netzo/apis/mailchimpmarketing/types.ts'

const data: DataScheduleCampaign = { schedule_time: '2024-05-30T15:00' }
const resultData = await api.campaigns[CAMPAIGN_ID].post<{}>(data)
import type { DataScheduleCampaign } from 'netzo/apis/mailchimpmarketing/types.ts'

const data: DataScheduleCampaign = { schedule_time: '2024-05-30T15:00' }
const resultData = await api.campaigns[CAMPAIGN_ID].post<{}>(data)

References ​

Copyright © 2023 Netzo