• API
  • Newsletter
View All APIs

Newsletter API

Version 1

Endpoint: https://api.peoplevine.com/newsletter.asmx
WSDL: https://api.peoplevine.com/newsletter.asmx?WSDL

30 Methods

addNewsletterRecipient

Version 1 This method allows you to add a recipient to a newsletter. {reference_type: customer, attribute, survey, contest, membershipcard, all}

https://api.peoplevine.com/newsletter.asmx/addNewsletterRecipient
View Method

addNewsletterRecipients

Version 1 This method allows you to add multiple recipients to a newsletter. {reference_type: customer, attribute, survey, contest, membershipcard, all}

https://api.peoplevine.com/newsletter.asmx/addNewsletterRecipients
View Method

assignPhoneNumber

Version 1 This method allows you to register a phone number.

https://api.peoplevine.com/newsletter.asmx/assignPhoneNumber
View Method

createNewsletter

Version 1 This method allows you to create a newsletter.

https://api.peoplevine.com/newsletter.asmx/createNewsletter
View Method

createNewsletterField

Version 1 This method allows you to create newsletter fields.

https://api.peoplevine.com/newsletter.asmx/createNewsletterField
View Method

deleteNewsletterSchedule

Version 1 This method is used to delete an existing schedule for a newsletter.

https://api.peoplevine.com/newsletter.asmx/deleteNewsletterSchedule
View Method

removeNewsletterRecipient

Version 1 This method allows you to remove a recipient from a newsletter.

https://api.peoplevine.com/newsletter.asmx/removeNewsletterRecipient
View Method

returnAvailableNumbers

Version 1 This method allows you to check phone number availability.

https://api.peoplevine.com/newsletter.asmx/returnAvailableNumbers
View Method

returnMessages

Version 1 This method allows you to return a list of messages that were sent or received.

https://api.peoplevine.com/newsletter.asmx/returnMessages
View Method

returnNewsletter

Version 1 This method allows you to return your newsletters.

https://api.peoplevine.com/newsletter.asmx/returnNewsletter
View Method

returnNewsletterClicks

Version 1 This method allows you to return your newsletter click stats.

https://api.peoplevine.com/newsletter.asmx/returnNewsletterClicks
View Method

returnNewsletterLog

Version 1 This method allows you to return your newsletter log.

https://api.peoplevine.com/newsletter.asmx/returnNewsletterLog
View Method

returnNewsletterReceived

Version 1 This method allows you to return the details for a newsletter sent to an individual.

https://api.peoplevine.com/newsletter.asmx/returnNewsletterReceived
View Method

returnNewsletterRecipients

Version 1 This method allows you to return the recipients of your newsletter.

https://api.peoplevine.com/newsletter.asmx/returnNewsletterRecipients
View Method

returnNewsletterSchedule

Version 1 This method is used to return the schedule for a speicific newsletter.

https://api.peoplevine.com/newsletter.asmx/returnNewsletterSchedule
View Method

returnNotifications

Version 1 This method is used to return a list of the notifications you currently have setup.

https://api.peoplevine.com/newsletter.asmx/returnNotifications
View Method

returnNumberSettings

Version 1 This method allows you to return the settings for a number.

https://api.peoplevine.com/newsletter.asmx/returnNumberSettings
View Method

scheduleNewsletter

Version 1 This method allows you to schedule a newsletter to be sent out. {reference_type: coupon, couponRedeemed, subscription, membership, membershipScan, vote, survey, contest or blank} {send_when: now, scheduled, repeat, action, drip}

https://api.peoplevine.com/newsletter.asmx/scheduleNewsletter
View Method

sendEmail

Version 1 This method allows you to send an email message.

https://api.peoplevine.com/newsletter.asmx/sendEmail
View Method

sendNewsletterTo

Version 1 This method allows you to send a newsletter direct to a set of recipients.

https://api.peoplevine.com/newsletter.asmx/sendNewsletterTo
View Method

sendSMS

Version 1 This method allows you to send a text message

https://api.peoplevine.com/newsletter.asmx/sendSMS
View Method

setupNotification

Version 1 This method allows you to setup a default notification for a specific reference type.

https://api.peoplevine.com/newsletter.asmx/setupNotification
View Method

trackNewsletter

Version 1 This method allows you to track a newsletter and update the log.

https://api.peoplevine.com/newsletter.asmx/trackNewsletter
View Method

trackNewsletterClick

Version 1 This method allows you to track a newsletter link click.

https://api.peoplevine.com/newsletter.asmx/trackNewsletterClick
View Method

unsubscribeRecipient

Version 1 This method allows you to unsubscribe a recipient.

https://api.peoplevine.com/newsletter.asmx/unsubscribeRecipient
View Method

updateNewsletter

Version 1 This method allows you to update a newsletter.

https://api.peoplevine.com/newsletter.asmx/updateNewsletter
View Method

updateNewsletterFields

Version 1 This method allows you to update newsletter fields.

https://api.peoplevine.com/newsletter.asmx/updateNewsletterFields
View Method

updateNewsletterSchedule

Version 1 This method is used to update an existing schedule for a newsletter.

https://api.peoplevine.com/newsletter.asmx/updateNewsletterSchedule
View Method

updateNumberSettings

Version 1 This method allows you to update a phone number.

https://api.peoplevine.com/newsletter.asmx/updateNumberSettings
View Method

viewNewsletter

Version 1 This method allows you to view a newsletter without all details.

https://api.peoplevine.com/newsletter.asmx/viewNewsletter
View Method