Skip to main content
PATCH
/
v1
/
deals
/
{id}
Update a deal
curl --request PATCH \
  --url https://api.vendaze.com/v1/deals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "USD",
  "price_cts": 1,
  "owner_email": "joao@company.com",
  "forecast_date": "2023-11-07T05:31:56Z",
  "person_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "company_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "tags": [
    "<string>"
  ],
  "custom_fields": [
    {
      "field_key": "deal_source",
      "value": "<string>"
    }
  ],
  "products": [
    {
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 1,
      "unit_price_cts": 50000
    }
  ],
  "association_mode": "append"
}
'
import requests

url = "https://api.vendaze.com/v1/deals/{id}"

payload = {
    "name": "<string>",
    "pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currency": "USD",
    "price_cts": 1,
    "owner_email": "joao@company.com",
    "forecast_date": "2023-11-07T05:31:56Z",
    "person_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "company_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "tags": ["<string>"],
    "custom_fields": [
        {
            "field_key": "deal_source",
            "value": "<string>"
        }
    ],
    "products": [
        {
            "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity": 1,
            "unit_price_cts": 50000
        }
    ],
    "association_mode": "append"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    pipeline_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    stage_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    currency: 'USD',
    price_cts: 1,
    owner_email: 'joao@company.com',
    forecast_date: '2023-11-07T05:31:56Z',
    person_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    company_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    tags: ['<string>'],
    custom_fields: [{field_key: 'deal_source', value: '<string>'}],
    products: [
      {
        product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        quantity: 1,
        unit_price_cts: 50000
      }
    ],
    association_mode: 'append'
  })
};

fetch('https://api.vendaze.com/v1/deals/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vendaze.com/v1/deals/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'pipeline_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'stage_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'currency' => 'USD',
    'price_cts' => 1,
    'owner_email' => 'joao@company.com',
    'forecast_date' => '2023-11-07T05:31:56Z',
    'person_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'company_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'tags' => [
        '<string>'
    ],
    'custom_fields' => [
        [
                'field_key' => 'deal_source',
                'value' => '<string>'
        ]
    ],
    'products' => [
        [
                'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'quantity' => 1,
                'unit_price_cts' => 50000
        ]
    ],
    'association_mode' => 'append'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vendaze.com/v1/deals/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"pipeline_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"stage_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"currency\": \"USD\",\n  \"price_cts\": 1,\n  \"owner_email\": \"joao@company.com\",\n  \"forecast_date\": \"2023-11-07T05:31:56Z\",\n  \"person_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"company_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"custom_fields\": [\n    {\n      \"field_key\": \"deal_source\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"products\": [\n    {\n      \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 1,\n      \"unit_price_cts\": 50000\n    }\n  ],\n  \"association_mode\": \"append\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.vendaze.com/v1/deals/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"pipeline_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"stage_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"currency\": \"USD\",\n  \"price_cts\": 1,\n  \"owner_email\": \"joao@company.com\",\n  \"forecast_date\": \"2023-11-07T05:31:56Z\",\n  \"person_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"company_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"custom_fields\": [\n    {\n      \"field_key\": \"deal_source\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"products\": [\n    {\n      \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 1,\n      \"unit_price_cts\": 50000\n    }\n  ],\n  \"association_mode\": \"append\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.vendaze.com/v1/deals/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"pipeline_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"stage_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"currency\": \"USD\",\n  \"price_cts\": 1,\n  \"owner_email\": \"joao@company.com\",\n  \"forecast_date\": \"2023-11-07T05:31:56Z\",\n  \"person_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"company_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"custom_fields\": [\n    {\n      \"field_key\": \"deal_source\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"products\": [\n    {\n      \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 1,\n      \"unit_price_cts\": 50000\n    }\n  ],\n  \"association_mode\": \"append\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Acme Corp Annual Contract",
    "amount": 250000,
    "currency": "USD",
    "formatted_amount": "R$ 2.500,00",
    "pipeline": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "stage": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "owner": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "John Smith",
      "email": "john@company.com"
    },
    "source": "My Integration App",
    "forecast_date": "2023-11-07T05:31:56Z",
    "entity_id": "NEG-0001",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "products": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "quantity": 2,
        "unit_price_cts": 50000,
        "total_price_cts": 100000
      }
    ],
    "custom_fields": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "value": "<unknown>",
        "field": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "label": "<string>",
          "key": "<string>",
          "type": "<string>"
        }
      }
    ],
    "tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "color_text": "<string>",
        "color_background": "<string>"
      }
    ],
    "people": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "full_name": "<string>",
        "emails": [
          {
            "email": "<string>",
            "type": "<string>"
          }
        ],
        "phones": [
          {
            "phone": "<string>",
            "type": "<string>"
          }
        ],
        "avatar_url": "<string>",
        "entity_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "companies": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "full_name": "<string>",
        "emails": [
          {
            "email": "<string>",
            "type": "<string>"
          }
        ],
        "phones": [
          {
            "phone": "<string>",
            "type": "<string>"
          }
        ],
        "avatar_url": "<string>",
        "entity_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}
{
  "error": {
    "code": "bad_request",
    "message": "No fields provided for update.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid Authorization header.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}
{
  "error": {
    "code": "insufficient_scope",
    "message": "This endpoint requires the 'webhooks:read' scope.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Webhook not found.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}
{
  "error": {
    "code": "validation_error",
    "message": "Validation failed.",
    "fields": {
      "url": "url must use HTTPS.",
      "events": "At least one event is required."
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}
{
  "error": {
    "code": "internal_error",
    "message": "An unexpected error occurred.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Authorizations

​
Authorization
string
header
required

OAuth 2.1 access token.

Path Parameters

​
id
string<uuid>
required

UUID of the resource.

Body

application/json
​
name
string
Maximum string length: 70
​
pipeline_id
string<uuid>
​
stage_id
string<uuid>
​
currency
enum<string>

ISO 4217 currency code supported by Vendaze.

Available options:
AED,
ARS,
AUD,
BRL,
CAD,
CHF,
CLP,
CNY,
COP,
DKK,
EGP,
EUR,
GBP,
HKD,
ILS,
INR,
JPY,
KWD,
MAD,
MXN,
MYR,
NGN,
NOK,
NZD,
PEN,
QAR,
SAR,
SEK,
SGD,
TRY,
USD,
UYU,
ZAR
Example:

"USD"

​
price_cts
integer

Deal value in cents.

Required range: x >= 0
​
owner_email
string<email> | null

Email of the workspace member to set as owner.

Example:

"joao@company.com"

​
forecast_date
string<date-time> | null
​
person_ids
string<uuid>[]
​
company_ids
string<uuid>[]
​
tags
string[]

Tag keys to associate with the deal.

Required string length: 1 - 30
​
custom_fields
object[]

Custom field values to set for the deal.

​
products
object[]
​
association_mode
enum<string>
default:append
Available options:
append,
replace

Response

Deal updated successfully.

​
data
object