API Reference
  1. Recruiter API

Create Contact in Group

post
https://api.app.franchiselab.com/api/contact/

Use this endpoint to create a Contact record within a Group, if you have Groups enabled.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Instead of this endpoint, you can still choose to use the Create Contact endpoint without Group IDs. In this case, your Contacts will be created in the first Group (Group 1) by default. More info on using Groups with APIs here.

Path Params
string
required

Group ID in which you want to add the Contact.

Body Params
string
required

Contact first name. Must contain alphanumeric characters, hyphens, apostrophes, and space.

string
required

Contact last name. Must contain alphanumeric characters, hyphens, apostrophes, and space.

string
required

Contact email. Must meet email validation criteria with an @ symbol and a valid domain url. Must be a unique, new email address.

string
required

Contact mobile number. Must meet phone validation criteria, and meet the correct number of digits for the coutry and area code.

string

Contact address field. Can be a full address with street details, or just a suburb, state, or country.

Responses

Updated over 2 years ago

What’s Next

View the Groups page to learn how to find and use your Group IDs

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago

What’s Next

View the Groups page to learn how to find and use your Group IDs