Sign in

v1

latestSwagger 2.02026-08-065854114.9 KB
deals

Update a deal.

put/deals/{id}

Path parameters

idinteger required

Request body

titlestring

Title to identify this deal.

valuenumber float

Monetary value.

descriptionstring

Your own description of this deal.

startTimestring date-time

When this deal was started.

productsstring
ownerUserinteger

Owner user ID or email

allowedUsersinteger[]

Array of IDs of users that should be able to see this deal.

allowToAllUserstrue

Set true if this deal should be visible to all users.

customFieldsobject

Custom Fields information. A key-value map where each key is the identifier (name) of a custom field and the value is the desired content.

Example: { "customFields": { "custom_field_identifier_1" : "desired value", "custom_field_identifier_2" : "desired value 2" } }

checkRequiredFieldsboolean

Check if required fields are filled when changing the deal stage or status.

Response

OK

Example response

{
  "data": {
    "organization": {
      "contact": {
        "work": "(99) 9999-9999",
        "mobile": "(99) 99999-9999",
        "whatsapp": "+5511999999999"
      },
      "address": {
        "postalCode": "99999-999"
      }
    },
    "person": {
      "contact": {
        "work": "(99) 9999-9999",
        "mobile": "(99) 99999-9999",
        "whatsapp": "+5511999999999"
      },
      "address": {
        "postalCode": "99999-999"
      }
    }
  }
}