Version: 2021-07-28

Create Sub-Account (Formerly Location)

POST /locations/

Create a new Sub-Account (Formerly Location) based on the data provided

info

This feature is only available on Agency Pro ($497) plan.

Request

Version stringrequired

API Version

Available options2021-07-28

application/json

application/json

Body
Example (auto)

Bodyrequired

namestringrequired

The name for the sub-account/location

phonestring

The phone number of the business for which sub-account is created with the appropriate country-code

companyIdstringrequired

Company/Agency Id

addressstring

The address of the business for which sub-account is created

citystring

The city where the business is located for which sub-account is created

statestring

The state in which the business operates for which sub-account is created

countrystring

The 2 letter country-code in which the business is present for which sub-account is created

Available optionsAFAXALDZASADAOAIAQAGARAM

postalCodestring

The postal code of the business for which sub-account is created

websitestring

The website of the business for which sub-account is created

timezonestring

The timezone of the business for which sub-account is created

prospectInfoobject

settingsobject

The default settings for location

socialobject

The social media links for location

twilioobjectdeprecated

(DEPRECATED) The twilio credentials for location

mailgunobject

The mailgun credentials for location

snapshotIdstring

The snapshot ID to be loaded into the location.

{
  "name": "Mark Shoes",
  "phone": "+1410039940",
  "companyId": "UAXssdawIWAWD",
  "address": "4th fleet street",
  "city": "New York",
  "state": "Illinois",
  "country": "US",
  "postalCode": "567654",
  "website": "https://yourwebsite.com",
  "timezone": "US/Central",
  "prospectInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]"
  },
  "settings": {
    "allowDuplicateContact": false,
    "allowDuplicateOpportunity": false,
    "allowFacebookNameMerge": false,
    "disableContactTimezone": false
  },
  "social": {
    "facebookUrl": "https://www.facebook.com/",
    "googlePlus": "https://www.googleplus.com/",
    "linkedIn": "https://www.linkedIn.com/",
    "foursquare": "https://www.foursquare.com/",
    "twitter": "https://www.foutwitterrsquare.com/",
    "yelp": "https://www.yelp.com/",
    "instagram": "https://www.instagram.com/",
    "youtube": "https://www.youtube.com/",
    "pinterest": "https://www.pinterest.com/",
    "blogRss": "https://www.blogRss.com/",
    "googlePlacesId": "ChIJJGPdVbQTrjsRGUkefteUeFk"
  },
  "mailgun": {
    "apiKey": "key-XXXXXXXXXXX",
    "domain": "replies.yourdomain.com"
  },
  "snapshotId": "XXXXXXXXXXX"
}

application/json

Successful response

application/json

Schema
Example (auto)

Schema

idstring

Location Id

companyIdstring