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:

Form BODY parameters
Name Required Example
shop_id required 14
campaign_id required 51
phone_number required 8585551234
sms_optin optional true
email optional
first_name optional Dexter
last_name optional Rocketman
tags[] optional tag1
tags[] optional tag2
Example REST Request
curl -X POST \
 -d "shop_id=14&campaign_id=51&phone_number=8585551234&sms_optin=true&[]=VIP&tags[]=Male"
Example Response
{ status: 'success' }
Example Form