API Reference

Groups

If you have Groups functionality enabled, you can specify which Groups to create your Contact in

If you have Groups functionality enabled, you can specify which Group to create your Contact in using the 'Create Contact in Group' endpoint. Alternatively, you can continue to use 'Create Contact', and all Contacts will be created in the first Group (Group 1) by default.

You will need to pass in the relevant Group ID as part of your Create Contact in Group call.

To find your Group IDs, follow the steps below:

  1. Log in to FranchiseLab Recruiter as an Administrator user.
  2. Navigate to Settings by clicking the gear icon on the bottom left
  3. Navigate to API Settings on the left-hand navigation bar.
  4. Ensure 'Enable API' is toggled on.
  5. Copy the fields for each relevant Group IDs

Once you've obtained your Group IDs, it needs to be passed in the groupID request parameter in the Create Contact in Group call.