POST /v1/entity/description

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


Path:  /v1/entity/description

Authentication: API Key required, User ID required

Description: upload/replace a description for an entity. An entity can have many descriptions


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
headline string no Headline of the description "Our Services"
body string yes Body of the description "Plumbing, central heating and boiler repair"
gen_id string no if provided will replace the relevant description with the one in the call. 589514645131264


Sample Success Response:

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

Docs Navigation