POST /v1/entity/document


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

Authentication: API Key required, User ID required

Description: upload a document for an entity



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
name string yes The display name of the document "Menu"
filedata string yes name of the file  to be uploaded. Only pdf, doc ,odt, docx filetypes are accepted.


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

curl -X POST -F 'filedata=@menu.pdf' -F 'entity_id=437956646973440' -F 'api_key=<your_key>' -F '_user_id=<your_user_id>' ''

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"

Docs Navigation