POST /v1/entity/featured_message

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

Authentication: API Key required, User ID required

Description: upload a featured message for an entity. An entity can only have one featured message


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
featured_text string yes Short string of text to display.  "Enquire about exclusive use of our banquetting suite"
featured_url url no Landing url for the featured message


Sample Success Response:

    "success": true,
    "msg": "ok",
    "data": {
        "ok": true,
        "id": "437958282420225",
        "rev": "95-3747c3da2c0f5c2da74ef1c1c541acc8"

Docs Navigation