Retention Rocket

Form Campaign Integration

Form Builder Campaign

Want to use a form to collect customer opt-ins? That's the purpose of the Form Builder campaign. Form landing pages can be hosted on Retention Rocket, or you can create a custom form on your site. This document describes how to integrate a custom form to Retention Rocket using AJAX or regular HTML form.

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

Submit customer information via AJAX

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 Doggo
Example Response
{ status: 'success' }
Example Request
curl --location --request POST "https://api-prod.retentionrock.com/rocketsdk/form_submit.json" \
  --data "shop_id=14&campaign_id=51&phone_number=8585551234&sms_optin=true&email=dexter@homey.org&first_name=Dexter&last_name=Doggo"

Submit via HTML Form

Form action https://api-prod.retentionrock.com/rocketsdk/form_submit
Form 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 Doggo
Example Form