Sign in

v1

latestSwagger 2.02026-08-065854114.9 KB
deals

Create a new deal for organization.

post/organizations/{organization_id}/deals

Path parameters

organization_idinteger required

Request body

titlestring required

Title to identify this deal.

dealStatusText'ongoing' | 'won' | 'lost'

Deal status name.

descriptionstring

Your own description for this deal.

endTimestring date-time

When this deal was finished.

productsstring[]
ranking0 | 1 | 2 | 3 | 4 | 5

Ranking displayed as stars in deal page.

startTimestring date-time

When this deal started.

authorinteger

User ID of the author of this deal.

ownerUserinteger

Owner user ID or email.

funnelinteger

Funnel ID.

dealStageinteger

Deal stage sequence number.

valuenumber float

Monetary value of this deal.

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

Created

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"
      }
    }
  }
}