Autoloaders (by API)

12 August 9, 2024

New franchise Candidates can automatically load into FZM, using the FZM restful API. This means you don’t have to manually key them in. They can come from your website, or Social Media pages and campaigns.

The API allows you to submit (POST) a Candidate to FZM. When the function is called your BSVName and PIN parameters are checked and if passed a new Candidate record will be created with the provided parameters.

You do not need to use all parameters, note there are four optional fields to suit any unique requirements you may have.

A few notes:

  • All submissions must have the Header
  • Content-Type: application/json
  • API endpoints have a timeout set of 5 seconds
  • All string parameters should not include any special characters eg < > & % “ ‘ *

Endpoint:

https://api.franchizemanager.com/fzm/loadenquiry

Parameters:

Parameter Name

Mandatory/Optional

Description/Note

BSVName

Mandatory, string
(100 max)

This is a static text parameter, the value will be provided to you by FZM Support. It must be included in every POST.

PIN

Mandatory, string
(100 max)

This is a static text parameter, the value will be provided to you by FZM Support. It must be included in every POST.

Source

Optional, string
(100 max)

This is the source of the Enquiry, we recommend you set this to the URL of the form doing the submission.

BrandOptional, string
(100 max)

The brand name of the Franchise.

Useful for multi-brand FZM installs.

FirstName

Optional, string
(100 max)

First Name field from the form

LastName

Optional, string
(100 max)

Last Name field from the form

FullNameOptional, string
(100 max)		Full Name field from the form

Email

Optional, string
(100 max)

Email field from the form

Phone

Optional, string
(100 max)

Phone field from the form

StreetAddress1

Optional, string
(100 max)

Address line 1 from the form

StreetAddress2

Optional, string
(100 max)

Address line 2 from the form

Suburb

Optional, string
(100 max)

Suburb field from the form

State

Optional, string
(100 max)

State field from the form

Zip

Optional, string
(100 max)

Zip or Post Code field from the form

HearAbout

Optional, string
(100 max)

‘How did you hear about us?’ field from the form

Timeframe

Optional, string
(100 max)

‘Timeframe’ field from the form

Funding

Optional, string
(100 max)

‘Level of Funding’ field from the form

StateInterest

Optional, string
(100 max)

‘State of interest’ field from the form

LocationInterest

Optional, string
(100 max)

‘Location of interest’ field from the form

SugLocation

Optional, string
(100 max)

‘Suggested location’ field from the form

SugSuburb

Optional, string
(100 max)

‘Suggested suburb’ field from the form

Comment

Optional, string

(2000 max)

Comment field from the form

Option1

Optional, string
(2000 max)

Optional field can be mapped to attribute in FZM

Option2

Optional, string
(2000 max)

Optional field can be mapped to attribute in FZM

Option3

Optional, string
(2000 max)

Optional field can be mapped to attribute in FZM

Option4

Optional, string
(2000 max)

Optional field can be mapped to attribute in FZM

Option5

Optional, string
(2000 max)

Optional field can be mapped to attribute in FZM

 Headers:

Content-Type: application/json

Sample Request:

{  
  "BSVName":"PizzaHut",
  "PIN":"41323",
  "Source":"http://myfranchise.com/enquirenow",
  "FirstName":"Ron",
  "LastName":"Hopkins",
  "Email":"ron@me.com",
  "Phone":"02 8976 6666",
  "StreetAddress1":"123 Main Street",
  "Suburb":"Sydney",
  "State":"NSW",
  "Zip":"2101",
  "HearAbout":"Radio station ZZZ",
  "Funding":"$100000-$500000",
  "StateInterest":"NSW",
  "LocationInterest":"Dee Why",
  "SugLocation":"anywhere near the beach",
  "SugSuburb":"Dee Why",
  "Comment":"I'm really keen to move on this ASAP, please call me."
}

Return (Response) values:

Submitting successfully will result in a success message.

An example Success message is:

{
 "message": "OK",
 "status": true
}

 

An example of an Error message where no parameter has been supplied for a ‘mandatory’ field, as described above:

{
 "message": "Invalid Params"
 "status": false
}

 

Any questions should be directed to FZM Support