POST /v1/entity/website

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: POST

Path:  /v1/entity/website

Authentication: API Key required, User ID required

Description: upload an website URL for an entity

Parameters:

 

Parameter Type Mandatory Description Example
api_key string yes the user API key b66qw3edr56thhg
_user_id string yes The user user_id ax34er6tt65edr
entity_id string yes The entity ID being manipulated
 379275323781120
website_url  string yes The website address centralindex.com; www.centralindex.com; http://centralindex.com
display_url string no How the url should display "Visit our site"
website_description string no A description of the site "Facebook profile"

 

Sample Success Response:

{
    "success": true,
    "msg": "ok",
    "data": {
        "ok": true,
        "id": "379275323781120",
        "rev": "29-f8659797282cbbfffa92c20731486e38"
    }
}

version 2 as of 5 years ago by Unknown

Docs Navigation