Create a new deal

POST

https://sandbox.useme.com/api/1.0/deal/

Creates a new deal with the provided details. This operation involves registering the deal and creating related deal stages.

Request

Header Params

Body Params application/json

Example

{
    "partner_id": "unique-ID-of-deal",
    "contractor_email": "user@example.com",
    "name": "Deal name",
    "description": "Deal description",
    "budget": "1000.00",
    "currency": "EUR",
    "work_days": 30,
    "sub_category_id": 75
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.useme.com/api/1.0/deal/' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "partner_id": "unique-ID-of-deal",
    "contractor_email": "user@example.com",
    "name": "Deal name",
    "description": "Deal description",
    "budget": "1000.00",
    "currency": "EUR",
    "work_days": 30,
    "sub_category_id": 75
}'

Responses

🟢201Returns the newly created deal's ID and associated stage IDs.

application/json

Body

Example

{
    "success": true,
    "data": {
        "id": 0,
        "stage_ids": [
            0
        ]
    }
}

🟠400Invalid input parameters or validation errors.

🟠409Indicates that the deal already exists.

Modified at 2024-05-07 08:34:28

Create a new contractor

Retrieve a specific deal