Retention Rocket

Form Campaign API And Custom Integration

Form Builder Campaign

This document describes how to integrate customer details with Retention Rocket. A Form Builder campaign is used to collect customer information. It can be in the form of a Retention Rocket hosted landing page, a custom form you build, or submitted as a HTTP POST request using REST or AJAX .

To enable this integration, you'll first need to create a Form Builder campaign in your Retention Rocket admin, then note the resulting shop_id and campaign_id from the bottom of the form campaign page after saving.

Example Form Builder Admin

URL for REST, AJAX or Form submit:

POST https://api-prod.retentionrock.com/rocketsdk/form_submit.json

Form BODY parameters

Name	Required	Example
shop_id	required	14
campaign_id	required	51
phone_number	required	8585551234
sms_optin	optional	true
email	optional	dexter@homey.org
first_name	optional	Dexter
last_name	optional	Rocketman
tags[]	optional	tag1
tags[]	optional	tag2

Example REST Request

curl -X POST https://api-prod.retentionrock.com/rocketsdk/form_submit.json \
 -d "shop_id=14&campaign_id=51&phone_number=8585551234&sms_optin=true&email=dexter@homey.org&first_name=Dexter&last_name=Rocketman&tags[]=VIP&tags[]=Male"

Example Response

{ status: 'success' }

Example Form

<h3>Sign up for SMS Offers and Alerts</h3>
<form action="https://api-prod.retentionrock.com/rocketsdk/form_submit" method="post">
    <input name="shop_id" type="hidden" value="YourShopId" />
    <input name="campaign_id" type="hidden" value="YourCampaignId" />
    <div>
        <label>Your Phone</label>
        <input name="phone_number" required="" type="tel" placeholder="Phone with area code" />
    </div>
    <div>
        <input checked="checked" type="checkbox" name="sms_optin" value="true" />
        <label>Receive support and marketing messages via text message*</label>
    </div>
    <div>
        <button type="submit">Submit</button>
    </div>
    <div><small> *By checking this box, I consent to receive marketing text messages sent through an automatic telephone dialing system from [COMPANY NAME] at the phone number provided. I verify that the phone number I have provided is my own. I understand that I do not need to consent to make a purchase. I understand that standard message and data rates may apply, and that I can text STOP to end all messages. </small></div>
</form>