API Reference
  1. Recruiter API

Create Contact

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

Use this endpoint to create a Contact record.

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

If you have Groups functionality enabled, calling this endpoint will create your Contact within the first Group (Group 1) by default. If you want to specify which Group to create the contact in, use the 'Create Contact in Group' endpoint. More info on using Groups with APIs here.

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

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