REST API

/business/create


Create a new business. businessOwnerErrorCode and businessOwnerErrorMessage will be returned only if the businessOwnerAccount parameter is present and set to 1. businessOwnerPassword will be returned only if the business owner was successfully created.

emailLogo: Image information for Company Logo (What is the Company Logo? See here: https://help.gatherup.com/wp-content/uploads/2014/10/logo-uploader-option.png ) We will resize your image for you. However for best results we recommend sizing the image. The max width is 260px. The following formats are supported: PNG, JPEG & GIF.

feedbackBanner: Image information for Feedback Page Banner (What is the Feedback Page Banner? See here: https://help.gatherup.com/wp-content/uploads/2014/12/feedback-page-banner-example.jpg ) We will resize your image for you. However for best results we recommend sizing the image correctly. The minimum width is 760px. The banner can be as tall or as narrow as you want. A good size is 250px in height. The following formats are supported: PNG, JPEG & GIF

emailImage: Image information for replacing the Google Map with a Logo or Image (What is the Google Maps image replacement? See here: https://help.gatherup.com/wp-content/uploads/2014/05/replace-google-maps-with-image.jpg ) We will resize your image for you. However for best results we recommend sizing the image correctly. The ideal size is 160px by 160px. The following formats are supported: PNG, JPEG & GIF

Note: New businesses will be billed within 24 hours of being added to the system.


Parameters

Name Type Required Example Description
businessName string yes Peach Trees Intl. Business name.
businessOwnerAccount integer(0,1) no 0 Set to 1 if you want to create business manager (aka User).
businessOwnerEmail string(email) no john.smith@abc-company.com User email.
businessOwnerFirstName string no John User first name.
businessOwnerLastName string no Smith User last name.
businessOwnerSendPasswordEmail integer(0,1) no 0 Send email with password
businessType string yes Insurance Agency Google business type.
city string yes Haiku Business city.
clientId string(40) yes 04f78...9f9f3 Client id is a unique user identifier provided by GatherUp.
country string yes US Business country code or full name.
customField string no 1234 Custom ID (whitelabeled accounts only).
emailImage string no http://domain.com/image-url Email Picture.
emailLogo string no http://domain.com/image-url Company Logo.
feedbackBanner string no http://domain.com/image-url Feedback Page Banner.
hash string(64) yes bd13a40...303f3c5 Hash is a digital request signature. Learn how to generate hash here.
organisationType string no company Organisation type: company, corporation, non profit, school, office, practice, agency, church,restaurant, event, firm, store, dealership
phone string yes 808-333-3334 Mobile phone number.
state string yes FL Business state code or full name.
streetAddress string yes 4150 Hana Hwy Business street address.
websiteUrl string no https://www.peachtreeintl.abc-company.com Business website url.
zip string yes 96708 Business zip code.
language string(2) no de, en, es, fr, nl, no, pl, pt, sv, it Business language

Request

{
   "businessName":"Peach Trees Intl.",
   "businessOwnerAccount":true,
   "businessOwnerEmail":"john.smith@abc-company.com",
   "businessOwnerFirstName":"John",
   "businessOwnerLastName":"Smith",
   "businessType":"Insurance Agency",
   "city":"Haiku",
   "clientId":"80338307b78b8d84c8b4d40e63e235cc312fcebe",
   "country":"US",
   "customField":"1234",
   "hash":"3b288032e87d12c08c95dc8a96128f19ec1ec207af383328413d18f9e0aaf1fd",
   "organisationType":"company",
   "phone":"808-333-3334",
   "state":"FL",
   "streetAddress":"4150 Hana Hwy",
   "websiteUrl":"https:\/\/www.peachtreeintl.abc-company.com",
   "zip":"96708"
}

Response

If businessOwnerAccount == 0 
{
   "businessId":5138,
   "errorCode":0,
   "errorMessage":"Success"
}
If businessOwnerAccount == 1 and Business Owner Account did not existed before 
{
   "businessId":5138,
   "businessOwnerErrorCode":0,
   "businessOwnerErrorMessage":"Success",
   "businessOwnerPassword":"PMZDAPQHtnClMaa",
   "errorCode":0,
   "errorMessage":"Success"
}
If businessOwnerAccount == 1 and Business Owner Account already exist 
{
   "businessId":5138,
   "businessOwnerErrorCode":0,
   "businessOwnerErrorMessage":"Success",
   "businessManagerId":3134,
   "errorCode":0,
   "errorMessage":"Success"
}

Errors

errorCode errorMessage
-1 Unknown error
1 Invalid hash sign
2 Invalid clientId
3 Server error - please contact support
14 Invalid business name
15 Unable to create business manager account
16 Business owner fields are invalid
17 Invalid street address
18 Invalid city
19 Invalid state
20 Invalid zip code
21 Invalid country
22 Invalid phone number
23 Unable to create business
24 Someone already registered an account using this email
29 Invalid business type