Useme API docs
  1. Deals
Useme API docs
  • Guides
    • Introduction
    • Getting Started
    • Creating Contractors
    • Creating Deals
  • Reference
    • Categories
      • List categories
    • Contractors
      • Create a new contractor
    • Deals
      • Create a new deal
        POST
      • Retrieve a specific deal
        GET
      • Upload a file for a deal
        POST
  1. Deals

Upload a file for a deal

POST
https://sandbox.useme.com/api/1.0/deal/file/
Deals
Allows authenticated users to upload files related to a deal stage. This endpoint expects a multipart form submission with a file and associated metadata.

Request

Header Params
Authorization
string 
required
Authorization token for the sandbox environment.
Default:
Token <here-paste-your-token>
Body Params multipart/form-data
file
file 
required
description
string 
optional
<= 512 characters
stage
integer 
required

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sandbox.useme.com/api/1.0/deal/file/' \
--header 'Authorization;' \
--form 'file=@""' \
--form 'stage=""'

Responses

🟢201The file has been successfully uploaded and associated with the deal stage.
application/json
Body
success
boolean 
optional
Default:
true
data
object (FileUploadData) 
required
file
string <uri>
required
Path to the uploaded file
description
string 
required
File description
stage
integer 
required
ID of the deal stage
Example
{
  "success": true,
  "data": {
    "file": "http://example.com",
    "description": "string",
    "stage": 0
  }
}
🟠400Invalid input parameters or validation errors.
Modified at 2024-05-07 08:34:28
Previous
Retrieve a specific deal
Built with