API Service Documentation

Command: send_system_email

Sends an email notification.

Example Request:

https://jason.apogeegate.com/aicore/backbone/service?ai_login_id=apiuser&ai_login_password=APIuser123&ai_command=send_system_email&id=12&from=nobody@yourcompany.com&to=somebody@mailhost.com&{"first_name":"John","last_name":"Smith","order_details":"The order receipt/details (this includes a standard Thank-You Message)","site_name":"Your Company","site_url":"www.yoursite.com","login_page":"www.yoursite.com/login","rep_id":"Representative ID"}

Request

NameTypeRequiredExample
idIntegerY12 (either 'id' or 'title' needs to be included; both is not allowed)
titleStringYenrollment_order_success (either 'id' or 'title' needs to be included; both is not allowed)
toStringYrecipient@theirsite.com
fromStringNadmin@yoursite.com
subjectStringNYoursite+Confirmation+Email
varsJSON objectN{"first_name":"John","last_name":"Smith","order_details":"The order receipt/details (this includes a standard Thank-You Message)","site_name":"Your Company","site_url":"www.yoursite.com","login_page":"www.yoursite.com/login","rep_id":"Representative ID"}
allow_htmlBooleanNtrue

Response

NameTypeExample
statusInteger0
status_messageStringSuccess