v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB

crm-v1-deals

Atualizar negociação

put/deals/{deal_id}

Path parameters

deal_idstring required

ID da negociação.

Request body

deal_stage_idstring

Example request

{
  "campaign": {
    "_id": "63d83e4f8cc2e6000f8e91c8"
  },
  "deal": {
    "deal_custom_fields": [
      {
        "custom_field_id": "63c188a315b034000fbf62d1",
        "value": [
          "Opção 1"
        ]
      }
    ],
    "name": "Negociação Atualizada",
    "organization_id": "64e002800e06f5000dad7673",
    "rating": 1,
    "user_id": "5d1e122a572a6c0034f2e595"
  },
  "deal_source": {
    "_id": "61140ea5c794c70001b71985"
  },
  "deal_stage_id": "633de55c96c4ac0019c8a638"
}

Response

Success

_idstring

amount_montlynumber

amount_totalnumber

amount_uniquenumber

best_moment_to_touchboolean

c_cf_errorsobject

campaign_idstring

closed_atstring date-time

contact_errorsobject

created_atstring

{"stackTrail":"paths:/deals/{deal_id}:put:responses:200:content:application/json:schema:properties:deal_lost_note","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/deals/{deal_id}:put:responses:200:content:application/json:schema:properties:deal_lost_reason_id","oasType":"schema","type":"unknown"}

deal_source_idstring

errorsobject

from_rdsm_integrationboolean

{"stackTrail":"paths:/deals/{deal_id}:put:responses:200:content:application/json:schema:properties:hold","oasType":"schema","type":"unknown"}

idstring

interactionsnumber

{"stackTrail":"paths:/deals/{deal_id}:put:responses:200:content:application/json:schema:properties:last_note_content","oasType":"schema","type":"unknown"}

namestring

prediction_datestring date

ratingnumber

updated_atstring

{"stackTrail":"paths:/deals/{deal_id}:put:responses:200:content:application/json:schema:properties:win","oasType":"schema","type":"unknown"}

Example response

{
  "_id": "ID",
  "amount_total": 399.83,
  "amount_unique": 399.83,
  "campaign": {
    "_id": "ID",
    "id": "ID",
    "name": "Campanha A"
  },
  "campaign_id": "ID",
  "created_at": "2023-08-30T21:55:50.376-03:00",
  "deal_custom_fields": [
    {
      "custom_field": {
        "_id": "ID",
        "allow_new": true,
        "created_at": "2023-01-13T13:36:51.156-03:00",
        "for": "deal",
        "instance_id": "ID",
        "label": "Assuntos relacionados",
        "opts": [
          "Assunto 2"
        ],
        "order": 1,
        "required_rules": [
          {
            "_id": "64f09657eb9e69000dcfd3ca",
            "created_at": "2023-08-31T10:32:07.309-03:00",
            "property": "deal_stage_id",
            "updated_at": "2023-08-31T10:32:07.309-03:00",
            "value": "5c911f5221fdf40026e2ae9b"
          }
        ],
        "type": "option",
        "updated_at": "2023-08-30T21:51:06.034-03:00"
      },
      "custom_field_id": "ID",
      "value": "Opção A"
    }
  ],
  "deal_products": [
    {
      "_id": "ID",
      "amount": 1,
      "base_price": 199.91,
      "created_at": "2023-08-30T21:55:50.570-03:00",
      "description": "Description Product 1",
      "discount_type": "value",
      "id": "ID",
      "name": "Product 01",
      "price": 199.91,
      "product_id": "ID",
      "recurrence": "spare",
      "total": 199.91,
      "updated_at": "2023-08-30T21:55:50.570-03:00"
    }
  ],
  "deal_source": {
    "_id": "ID",
    "id": "ID",
    "name": "3.0"
  },
  "deal_source_id": "ID",
  "deal_stage": {
    "_id": "ID",
    "deal_pipeline_id": "ID",
    "id": "ID",
    "name": "Converteu",
    "nickname": "C"
  },
  "deal_stage_histories": [
    {
      "_id": "ID",
      "deal_stage_id": "ID",
      "id": "ID",
      "start_date": "2023-09-05T18:25:40.421-03:00"
    }
  ],
  "id": "ID",
  "interactions": 11,
  "name": "Negociação Atualizada",
  "organization": {
    "_id": "ID",
    "id": "ID",
    "name": "Empresa X",
    "organization_custom_fields": [
      {
        "_id": "64e002800e06f5000dad7665",
        "custom_field_id": "646e73a3651e44000f352486"
      }
    ],
    "visible": true
  },
  "rating": 1,
  "stop_time_limit": {
    "expiration_date_time": "2026-05-31T18:25:40.533-03:00"
  },
  "updated_at": "2023-09-05T18:25:40.534-03:00",
  "user": {
    "_id": "ID",
    "id": "ID",
    "name": "Tays Teixeira"
  }
}