list_campaigns: list_campagins

Description Usage Arguments Details Value See Also Examples

Description

Lists all of the campaigns under the specific client account.

Usage

1
2
3
list_campaigns()
list_campagins(auth)
list_campagins(client, auth)

Arguments

auth

your accounts API key. This is not necessary if you have set a global variable: Sys.setenv('CampMonauth' = "API_KEY")

client

The ClientID, this is not necessary if there is only one client ID.

Details

This function aims to list out every campaign that has been run off a specific account.

Value

Name

The name of the campaign. This is not visable to the recipient of the campaign.

FromName

The name of the sender of the campaign.

FromEmail

The Email the campaign has been sent from.

ReplyTo

The email that recipients can reply to.

SentDate

The date the campaign began.

TotalRecipients

How many recipients the campaign was sent to.

CampaignID

The ID of the campaign. This is useful for other functions in this package.

Subject

The subject line of the email.

WebVersionURL

A link to the full HTML version of the email.

WebVersionTextURL

A link to the text of the email, stripped of all HTML or CSS styling.

See Also

Client Campaign

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
#set API Key
Sys.setenv('CampMonauth' = "API_KEY")

All_Campaigns <- list_campaigns()

#If you haven't set the API key

All_Campaigns_with_API <- list_campaigns(auth = "API_KEY")

#you may have multiple clientIDs
#this is a random clientID
All_Campaigns_with_ClientID <- list_campaigns(client = "q6hu31d768hmgjo9745hjnf1e234abc" )

mark-brackenrig/campaignmonitoR documentation built on May 15, 2019, 9:58 p.m.