IRIS CRM can automatically create records to become leads or transition into merchant applications ready for on-boarding to your favorite processor.
Any data that is collected through a web form or corporate system can be imported into IRIS CRM in minutes using the simple steps described below.
The most common use of the POST API is to create records in IRIS using data that was collected from a form. A form can be a merchant application hosted on your website or a lead form that clients fill out such as a Contact Us page.
All of the information that is submitted through a form can be sent to IRIS CRM by properly mapping the fields and attaching a POST Token URL to the action button on your site. A simple example of a form that can be used to create a record in IRIS CRM is shown here:
Step By Step Guide For Creating New POST API Tokens
Below we describe the steps to configure, test, and use the POST API feature.
1. Navigate to Manage > Administration > POST API > POST URLs.
2. Select the desired User Group and click the "Create Token" button:
3. Fill in the pop-up with the actions that IRIS CRM should perform when new records such as leads or merchant applications are received from an external source. Note: Leave "Auto Import" unchecked for now.
Here is an example of how to configure a POST API Token:
4. Click "Add Token" to finish the process and you will see your token that will look like the example below, but be unique to your site (bold part will have your domain):
<form action="https://youririscrmdomain.com/postleads/t/12271effe32acade9d" method="POST">
5. Repeat the process to create a POST API Token for every source that you intend to collect data from. IRIS CRM provides you an unlimited amount of sources!
Step By Step Guide For Mapping Your POST API Token
1. After you created a token, the next step is to map the field names on your forms to correspond to the desired fields that in your IRIS CRM site. For assistance with adding new fields to IRIS CRM, review the Manage Lead Fields article.
2. Within your token go to the Mapping Lead Fields section:
3. Type in the field name for in the Field box and choose the matching IRIS field from the Assign To list and click Assign. Repeat for each field.
Tip: A field called "Telephone" in your form may not be called exactly that in the HTML. It may actually be something like "phone" or "ph_number" or something similar. The name, not the label, is what you'll put when entering the field mappings. Your web designer can supply the field name, and also, to see the Name of a field you may right-click it and choose the Inspect Element option. Here's an example of how that looks:
Mapping Text Fields: No special setup is needed beyond mapping the field name to its match.
Mapping Dropdowns: If you have a dropdown in your form, it can select the corresponding option in a dropdown in the IRIS lead by sending the name of the option in the dropdown in IRIS. For example, an Entity Type drop-down in your form with options for LLC, Partnership, and Corporation will map properly if the dropdown in IRIS has those options spelled exactly the same way.
Mapping Checkboxes: If you have a checkbox in your form that has a value="1" when checked, it can select option 1 in a drop-down or check a checkbox in the IRIS lead.
Mapping Comments: A comments/notes field in your form can be mapped using the Notes option:
Attaching Files: See the section below for the steps on how to send an uploaded file to the new lead.
4. After all of the fields are mapped, you should setup the form to submit to your POST API Token. This is often the only one line of code that is needed but will depend on how the whole form is built.
5. After the form code is updated with the POST API Token URL, and when you submit the form on your site with test info in the fields, you will be able to see the record on the Manage Inbound Leads page in IRIS CRM. Review the record to make sure that all of the fields from your web form are appearing correctly in the Lead. If not, you will need to re-check and update your form mapping and then try again. For more information please see our article on Managing Inbound Leads.
6. Once everything is confirmed as importing correctly, go back to the token that you originally created above, click Update Settings, and click the "Auto Import" check box to enable future records to be automatically imported.
7. Moving forward, whenever the data source's form is submitted, be it an MPA or a lead, the record will show up in searches and across IRIS instantly (for users who have access to it).
8. All imported records can be reviewed by navigating to Manage > Administration > POST API > POST Leads page:
If your form has a box for e-signature, the image of the signature can be included in the submission, as long as it is converted to Base64 before being sent into IRIS.
Any other files such as PDFs or images can be sent to IRIS in their standard format.
To set up the POST API Token to accept files with your submissions, enter the file upload's parameter/field name under Mapping Lead Fields and choose the "Lead File" option (at the bottom of the Assign To list). If you need to send multiple files, there must be separate upload fields for them in your form and each mapped to the "Lead File" option.
In your web form, make sure to add the "enctype" attribute. Example:
<form action="https://youriris.com/postleads/t/c998" method="POST" enctype="multipart/form-data">
Spamming Rules for POST API Tokens:
To help stop SPAM posters on your web forms, the following rules are in place to reject excessive submissions.
- If 100+ records are submitted in a 5 minute period, per IP address, additional records from that IP Address will be rejected for 1 day.
- If 360+ records are submitted in a 1 hour period, per IP address, additional records from that IP Address will be rejected for 1 day.