PUT /v1/business

NOTE: This method is not accessible to users on Starter Plan API keys. Please contact us if you want premium access to our service

HTTP Method: PUT

Path: /v1/business

Authentication: API Key required, User ID required

Description: Add a business entity to the Central Index. 

Parameters:

Parameter Type Mandatory Description Example
api_key string yes the user API key b66qw3edr56thhg
_user_id string yes The user user_id 2a45reft678ujh65rr
name string yes The name of the business Bob the Plumber
building_number string no Building name or number 36 or Colt House
address1 string yes Line 1 of address 14 Front Street
address2 string no Line 2 of address Canal View
address3 string no Line 3 of address The Burrow
town string no Town name Dublin
county string no county name County Dublin
postcode string no postcode N6 5LU
country string yes ISO-compatible country code ie
do_not_display Boolean no set to TRUE if address should not be displayed on websites.  Default is FALSE
latitude float no WSG-84 latitude 54.123456
longitude float no WSG-84 latitude -6.3234567
timezone timezone no Defaults to UTC UTC
telephone_number string yes the business main phone number +4420345678990
additional_telephone_number string no Additional phone number +447158911891
email email no The business email address info@mysite.com
website url no The business website http://www.mysite.com
category_type string  no  One of the taxonomies supported by Central Index sic_87, sic_2007, sic_03, NAICS
category_id string yes

If category_type is supplied, then this is the category id of the supported taxonomy.
 If category type is not supplied, this is the Central Index category id of the business

 1234
_supplier_id string no

This is the ID of the business as it is known by you you (the supplier).
If provided, the entity can be retrieved later using an GET /entity/by_supplier_id method 

 ABC123

 

Sample Response:

{
    "success": true,
    "msg": "Success - Entity successfully added",
    "data": {
        "matched": false,
        "entity_id": "443641326280704"
    }
}

 

A successful response will return the entity id of the entity that was added to the Central Index.

If  "matched" = TRUE, it means that the submitted details were matched to an existing entity and merged with those.

If "matched" = FALSE, it means that a new entity was added to the Central Index using the submitted details

To find Central Index category ids, you can use our category lookup method 

version 21 as of 5 years ago by Richard Vaughan

Docs Navigation