User.com REST API Docs

# Update deal

You can update a deal.

PATCH /deals/:id/

Attributes Type Required Description
id integer yes A unique identifier for the deal which is given by User.com automatically.
custom_id string no The unique identifier for the deal which is provided by the client.
activities_status string no A status of an activity assigned to the user.
assigned_to integer no A unique identifier for the agent which is given by User.com automatically.
company_id integer no A unique identifier for the company which is given by User.com automatically.
currency ISO 4217 code no A currency of a deal.
expected_close_date date no A date when the deal is expected to be closed.
loss_reason integer no A reason for a lost deal.
lost_at datetime no A date when the deal has been marked as lost.
name string no A deal name.
participants integer(list) no A list of user_ids assigned to a deal.
pipeline integer no An id of a pipeline where the deal is assigned to.
products integer(list) no A list of products' ids.
stage integer no An id of a stage of the pipeline the deal is currently at.
status integer no A status of your deal (0 - abandoned, 1 - in progress, 2 - won, 3 - lost, 4 - archived)
user_id integer no A unique identifier for the user which is given by User.com automatically.
value number no A value of a deal.
won_at datetime no A date when the deal has been marked as won.
user_custom_id string no The unique identifier for the user which is provided by the client.
company_custom_id string no The unique identifier for the company which is provided by the client.

# Request

  • CURL
  • JavaScript
  • PHP
  • Python 
curl -X POST -H "Authorization: Token <your_64_char_api_key>" -H "Content-Type: application/json" 
       -H "Accept: */*; version=2" -d '{
  "name": "Updated name",
  "description": "updated description",
}' "https://<your_app_subdomain>.user.com/api/public/deals/:id/"

# Response

{
    "id": 12218,
    "name": "example deal",
    "value": "1250.00",
    "currency": "USD",
    "custom_id": null,
    "stage": 36585,
    "pipeline": 6179,
    "assigned_to": 398,
    "restricted_to": null,
    "agent": null,
    "company_id": 768,
    "user_id": 20900530,
    "status": 1,
    "products": [],
    "scope": 2,
    "created_by": 382,
    "created_at": "2017-09-06T09:53:50.748535Z",
    "updated_at": "2017-09-06T09:53:50.748555Z",
    "tags": [{"id": 9, "name": "To call"}],
    "activities_status": "planned",
    "expected_close_date": null,
    "loss_reason": null,
    "loss_reason_description": "",
    "lost_at": null,
    "won_at": null,
    "participants": [4],
    "user_custom_id": "52bdc3be5145e87076c8",
    "products_custom_id": [],
    "company_custom_id": "c44adda2ecc0",
    "custom_attribute_xyz": null
}

← Update deal by id →