POST /v1/entity/image

 

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

Authentication: API Key required, User ID required

Description: upload an image 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
filedata string yes name of the image to be uploaded. Only jpg,png and gif images are accepted.
abc123.jpg

 

This is a multi-part CURL command. Example of a typical command:

curl -X POST -F 'filedata=@img01.jpg' -F 'entity_id=437956646973440' -F 'api_key=<your_key>' -F '_user_id=<your_user_id>' 'http://api.centralindex.com/v1/entity/image'

Note: the file to upload needs to be stored in the same place where the CURL command is being executed from.

 

Sample Success Response:

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

version 5 as of 6 years ago by Unknown

Docs Navigation