Opportunity
Create Opportunity

Create Opportunity

Creates a new Opportunity object.
POST/opportunity/create

Parameters

close_date - date required
The opportunity close date.

enterprise_identifier - string required
The contact’s id, name, email or cif for attach to the opportunity.

user_email - string required
The user's email for attach as opportunity responsible.

state - object ( State ) required
The opportunity state funnel.

More parameters

  • name - string
  • comments - string
  • extra_fields - array
  • products - array

We are still working on all definitons of each parameter.

Example (required parameters selected)
{
    "enterprise_identifier" : "contact@salesly.app",
    "user_email": "support@salesly.app",
    "close_date": "2025-01-01T00:00:00",
    "state": {
        "state": 1,
        "amount": 1000
    },
    "products": [
        {
            "reference": "PRODUCT_1344",
            "rate_sku": "RATE_1",
            "discount": 0,
            "quantity": 3,
            "comment": "",
            "description": ""
        }
    ]
}

Response

status 200

The created opportunity object.

Response
{
    "close_date": "2025-01-01T00:00:00",
    "enterprise_id": 23443,
    "user_id": 30,
    "name": "Contact Test_12-03-2025_17",
    "who_created": 30,
    "updated_at": "2025-03-12 11:42:01",
    "created_at": "2025-03-12 11:42:01",
    "id": 11646,
    "state": {
        "id": 26622,
        "state": 1,
        "amount": "1000.00",
        "opportunity_id": 11646,
        "created_at": "2025-03-12 11:42:01",
        "updated_at": "2025-03-12 11:42:01",
        "deleted_at": null,
        "comment": null,
        "name": "Stop - 0%"
    },
    "amount": "1000.00",
    "products_basic": [
        {
            "id": 1346,
            "name_ref": "() Product 1",
            "name": "Product 1",
            "description": " ",
            "store_name": " ",
            "store_description": " ",
            "pivot": {
                "opportunity_id": 11646,
                "product_id": 1346,
                "quantity": 3,
                "discount": 0,
                "price": "100.00000",
                "comment": null,
                "description": null,
                "cost": "0.00000",
                "product_rate_id": 1374,
                "position": null,
                "is_highlighted": 0
            },
            "rates": [
                {
                    "id": 1374,
                    "product_id": 1346,
                    "sku": "RATE_1",
                    "cost": "0",
                    "price": "100",
                    "services": null,
                    "primary": true,
                    "created_at": "2025-03-12 11:35:17",
                    "updated_at": "2025-03-12 11:35:17",
                    "name": "RATE_1 (100.00000)"
                }
            ]
        }
    ],
    "states": [
        {
            "id": 26622,
            "state": 1,
            "amount": "1000.00",
            "opportunity_id": 11646,
            "created_at": "2025-03-12 11:42:01",
            "updated_at": "2025-03-12 11:42:01",
            "deleted_at": null,
            "comment": null,
            "name": "Stop - 0%"
        }
    ]
}
OpportunityOrder