PUT /v1/business/json

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/json

Authentication: API Key required, User ID required

Description: Add or update a business entity to the Central Index by providing business data in JSON format

Parameters:

This endpoint is a one-stop shop to add a business entity with rich content to the Central Index in one go. Currently the following objects can be added:

The supported fields for each object are detailed in the Reference links.

Sample JSON document:

{
    "name": {
        "name": "Justine Claire Photography",
        "formal_name": ""
    },
    "postal_address": {
        "building_number": "8",
        "address1": "Bernard Road",
        "address2": "",
        "address3": "",
        "district": "",
        "town": "Arundel",
        "county": "West Sussex ",
        "province": "",
        "postcode": "BN18 9EP",
        "address_type": "",
        "do_not_display": false
    },
    "phones": [
        {
            "number": "01903 885791",
            "description": "",
            "trackable": false
        },
        {
            "number": "07739 465348 ",
            "description": "",
            "trackable": false
        }
    ],
    "categories": [
        {
            "category_id": "320"
        },
        {
            "category_id": "902"
        }
    ],
    "emails": [
        {
            "email_address": "info@justineclaire.com",
            "email_description": "Office"
        },
        {
            "email_address": "justine@justineclaire.com",
            "email_description": "Justine"
        }
    ],
    "websites": [
        {
            "website_url": "http://www.justineclaire.com",
            "display_url": "justineclaire.com",
            "website_description": ""
        }
    ],
    "socialmedia": [
        {
            "type": "facebook",
            "website_url": "http://www.facebook.com/justineclairephotography"
        },
        {
            "type": "twitter",
            "website_url": "http://twitter.com/justineweddings"
        }
    ],
    "descriptions": [
        {
            "headline": "",
            "body": "Welcome to Justine Claire Wedding Photography based in the beautiful historical town of Arundel West Sussex near Chichester. I am an experienced Sussex Wedding Photographer and I photograph weddings throughout East & West Sussex I also have strong relationships with wedding venues in Gloucestershire Surrey Wiltshire and Hampshire"
        },
        {
            "headline": "",
            "body": "My work is predominantly as a 'photo-journalist' but I am happy to take formal shots if required and enjoy taking the couple away from the crowd for a short while to take some special portraits. My energies and expertise are focused on people and moments which will produce the story of your wedding day in a light and unobtrusive style. "
        }
    ],
    "payment_types": [
        {
            "payment_type": "visa"
        },
        {
            "payment_type": "mastercard"
        },
        {
            "payment_type": "amex"
        }
    ],
    "faxes": [
        {
            "number": "01903 885792",
            "description": ""
        }
    ],
    "opening_times": {
        "monday": "09001730",
        "tuesday": "closed",
        "wednesday": "09001730,18001900",
        "thursday": "24hour"
    },
    "images": [
        {
            "image_url": "http://lorempixel.com/g/400/200/",
            "image_name": "Image 1"
        },
        {
            "image_url": "http://lorempixel.com/g/400/300/",
            "image_name": "Image 2"
        }
    ],
    "logos": [
        {
            "logo_url": "http://lorempixel.com/g/400/200/",
            "logo_name": "Logo"
        }
    ],
    "tags": [
        {
            "tag": "photographer",
            "language": "en"
        },
        {
            "tag": "wedding photos",
            "language": "en"
        }
    ],
    "testimonials": [
        {
            "title": "Thank you",
            "text": "Thank you so much for the fabulous photos, You were so subtle and caring, just the lovliest photographer a girl could wish for. We are thrilled with our pictures and so excited about our gorgeous album........",
            "testifier_name": "Amy and Gareth Hayden"
        },
        {
            "title": "Tears of joy",
            "text": "We have just finished looking through them all, they are absolutely wonderful! We can’t wait to share them with everyone. Thank you so much for capturing our day! Brought all our emotions back again, ...tears of joy...",
            "testifier_name": "Faye & Jamie"
        }
    ],
    "special_offers": [
        {
            "title": "10% off wedding albums",
            "description": "Get 10% off all wedding albums during August",
            "terms": "Valid on all orders placed 1st-31st August 2014",
            "start_date": "2014-08-1",
            "expiry_date": "2014-08-31",
            "url": "http://www.justineclaire.com/offers"
        }
    ],
    "featured_message": {
        "featured_text": "Planning you big day? Get in touch now!",
        "featured_url": "http://www.justineclaire.com/contact/"
    }
}

Sample Response:

{
    "success": true,
    "msg": "ok",
    "data": {
        "entity": {
            "matched": true,
            "entity_id": "549375109332992",
            "matchMethod": "byPhone",
            "deprecated": []
        },
        "validation": {
            "valid": true,
            "feedback": { ..... }
    }
}

The "feedback" Hash will contain feedback on any validation errors.

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. There will be some additional information as to the match method.

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