POST /v1/entity/image/by_url

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/image/by_url

Authentication: API Key required, User ID required

Description: upload an image to an entity by providing a url

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
image_url string yes the url of the image to be uploaded . Only jpg,png and gif images are accepted.
http://www.mysite.com/flower_display.jpg
image_name string no A description of the image Flower Display

Sample Success Response:

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

Docs Navigation