Overview
Returns details for a specific Autoresponder based on information sent via an http form post.
Post Url
https://hyperdrivepro.morethanrewards.com/api/2/GetAutoresponder.aspx
- SSL is required
Form Fields
Field | Max Length* | Required | Notes |
response_type | Yes | Set this field value to json to return results in JSON format | |
accountid | Yes | Must be numeric. Account ID for this account. | |
apikey | Yes | API Key for this account. | |
autoresponderid | Yes* | Either autoresponderid or autorespondername are required | |
autorespondername | Yes* | Either autoresponderid or autorespondername are required |
Sample Results
Success Message
<results> <autoresponder> <name>This is a Sample Autoresponder</name> <id>1234</id> <steps> <step> <daysfromstart>0</daysfromstart> <timeincrement>D</timeincrement> <incrementunits>0</incrementunits> <emailtemplatename>Welcome</emailtemplatename> <emailtemplateid>2294</emailtemplateid> </step> <step> <daysfromstart>14</daysfromstart> <timeincrement>W</timeincrement> <incrementunits>2</incrementunits> <emailtemplatename>Follow Up</emailtemplatename> <emailtemplateid>2299</emailtemplateid> <emailoverride>test@test.com</emailoverride> </step> </steps> </actionset> </results>
Notes:
- <emailoverride> – when set, the email is sent to this address instead of the contact address
- <timeincrement> – the time increment set in the UI (Days, Weeks, Months, Years)
- <incrementunits> – Multiplied by timeincrement to deterimine <daysfromstart>
- When <daysfromstart> is zero 0, the email will be sent as soon as the autoresponder is assigned.
Sample Failure Message
<?xml version="1.0"?> <results> <error>Authentication failed</error> </results>