Send Email API Function

From TMM Wiki
Jump to navigationJump to search
Members Admin
The Members Admin
View Member Details
Add Member
MySQL Auth
Mod Authn DB
Multisite Access
Member Logging
Member Password Retrieval
OpenID Connect
Mod Auth OpenIDC
ID Numbers
API Best Practices
WSDL Cache
Add Affiliate
Add Member Note
Admin Get Adtools
Adtool Categories
Adtool Types
Affiliate Get Campaigns
Bulk Import Adtools
Decode Natscode
Expire Manual Member
Get Affiliate Campaigns
Get Affiliate Hit Data
Get Affiliate Loginids
Get Affiliate Nats Codes
Get Affiliate Payout
Get Affiliate Program Campaign List
Get Member Details
Get Member Instant Upgrade String
Get Member Package Upgrade String
Get Member Token Rebuy String
Get Member Upsell String
Get Payment Data
Get Payvia Rule
Get Profit Loss Report
Record Member Login
Search Affiliate Info
Search Member Info
Send Email API Function
Set Affiliate Admin Settings
Set Affiliate Customs
Set Affiliate Defaults
Set Affiliate Information
Set Affiliate Settings
Set Member Details
Set Payment Status
Set Payvia Rule
API Overview
API Best Practices
GET /adtools/admin
GET /adtools/categories
GET /adtools/types
POST /adtools/importdump
GET /affiliate/campaigns
GET /affiliate/hitdata
GET /affiliate/payout
GET /affiliate/searchinfo
POST /affiliate/addaffiliate
POST /affiliate/invoice
PATCH /affiliate/setadminsettings
PATCH /affiliate/setcustoms
PATCH /affiliate/setdefaults
PATCH /affiliate/setinformation
PATCH /affiliate/setpayviainfo
PATCH /affiliate/setsettings
PATCH /affiliate/status
GET /member/authstring
GET /member/details
GET /member/searchinfo
GET /suggestedcanceloffers
PATCH /member/setdetails
PATCH /member/setexpiration
POST /member/addnote
POST /member/recordlogin
PUT /member/expiremanual
PATCH /member/forget
GET /option/options
GET /option/rule
PATCH /option/rule
POST /option/rule
GET /payments/getpayments
GET /payviarule
PATCH /payments/setstatus
PATCH /payviarule
GET /profitlossreport
Get /transactionpayouts
GET /report/transaction
GET /service/decodenatscode
GET /service/ping
POST /service/sendemail

The Send Email API Function is a new feature in the NATS Admin API that allows NATS to automatically send emails to members or affiliates. The function differentiates between members and affiliates based on whether the email uses a member ID number or login ID number as an argument.

Possible Arguments

This function takes into account the following arguments:

  • Subject - Define the subject of the email being sent
  • Type - Select whether you are sending your email to a member or affiliate.
  • Template - The name of the template being used for the email.
  • Member ID - The ID number if the email type is a Member email. This argument is required to be defined if the email is being sent to a member.
  • Login ID - The ID number if the email type is an Affiliate email. This argument is required to be defined if the email is being sent to an affiliate
  • Custom_vars - Indicates a serialized array of custom variables.

Required Arguments

Some of these arguments are required in order to send emails through the API:

  • Subject, Type, Template, and either Member ID or Login ID must be defined, or your emails will not be sent.
    • Member ID is required for sending email to members, Login ID is required for sending email to affiliates