Documents upload
Upload the real file onto a deal (multipart: file, kind, title): a proposal or agreement PDF, a Word file, a deck. It is kept and shown as itself.
POST/api/v1/deals/{id}/documents/upload
Parameters
Path
| Name | In | Description |
|---|---|---|
idrequired | path | The record's id. |
Body
A multipart/form-data body with two fields: file, the CSV or XLSX, and kind, either leads or companies.
Example
curl
curl -X POST "https://crm.ashwanth.dev/api/v1/deals/{id}/documents/upload" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
-F "file=@leads.csv" -F "kind=leads"CLI
sales-engine documents upload <id> --file "..."Response
A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.
Shape
{
"data": { ... }
}Run it below to see the live shape for your workspace.
Try it
Runs against this server, as the workspace behind the key. Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Path
requiredThe record's id.
File
filerequiredkindRequest
POST /api/v1/deals/%7Bid%7D/documents/upload
Fill the path first.