1.0.2 • Published 1 year ago

kril-cm-api v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

kril-cm-api

Disclaimer: I created this wrapper because I needed the transactional module. I decided to add all the endpoints from the documentation but I couldn't test all of them since I didn't have permission. Feel free to contribute :D

This library uses Campaign Monitor API v3.2

Getting started

npm install kril-cm-api

usage

import { Transactional } from 'kril-cm-api'

try {
  const apiKey = 'xxx='
  const transactional = new Transactional({ apiKey })
  const data = await transactional.getStatistics()
  console.log(data)
} catch (err) {
  console.log(err)
}

If you are using javascript don't forget to add @ts-check at the top of your file for a better experience

Modules

Campaign Monitor API documentation.

ModuleDescription
AccountGives you access to core account information.
CampaignsCovers all the campaign related functionality including creating draft campaigns, selecting recipients and sending.
ClientsContains all the functionality you need to manage the clients in your account
JourneysCovers read-only journey functionality including viewing all journeys, journey summary, and detailed journey reporting.
ListsCovers all your list management needs.
SegmentsSegments allow you to create targeted sub-groups of subscribers based on conditions you set.
SubscribersEverything you need to work with subscribers in your account.
TemplatesTemplates make it easy for your clients to send great looking emails by just adding their own content.
TransactionalTransactional emails are triggered by your own site or app, typically in response to a user's action