Update a deal

PUT/crm/{connection_id}/deal/{id}

Parameters

Payload

A deal represents an opportunity with companies and/or contacts

idstring

Unique identifier for this deal object

created_atdate-time

The date that this deal object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate-time

The last date that this deal object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

The name of this deal

amountnumber

The potential amount that deal could be worth

currencystring

The currency for the deal amount (3 letter ISO code; eg. USD)

closed_atdate-time

The date that this deal closed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

closing_atdate-time

expected closing date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

stages array

pipelines array

sourcestring

The source for this deal

probabilitynumber

tagsstring array

lost_reasonstring

won_reasonstring

user_idstring

(reference to HrisEmployee)

contact_idsstring array

(reference to CrmContact)

company_idsstring array

(reference to CrmCompany)

descriptionstring

metadata array

raw

The raw data returned by the integration for this deal

Returns

CrmDeal

Response field	Type	Required	Description
`id`	string	No	Unique identifier for this deal object
`created_at`	string (date-time)	No	The date that this deal object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	The last date that this deal object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`name`	string	No	The name of this deal
`amount`	number	No	The potential amount that deal could be worth
`currency`	string	No	The currency for the deal amount (3 letter ISO code; eg. USD)
`closed_at`	string (date-time)	No	The date that this deal closed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`closing_at`	string (date-time)	No	expected closing date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`stages`	CrmReference[]	No
`stages[].id`	string	No
`stages[].name`	string	No
`stages[].type`	string	No
`pipelines`	CrmReference[]	No
`pipelines[].id`	string	No
`pipelines[].name`	string	No
`pipelines[].type`	string	No
`source`	string	No	The source for this deal
`probability`	number	No
`tags`	string[]	No
`lost_reason`	string	No
`won_reason`	string	No
`user_id`	string	No	(reference to HrisEmployee)
`contact_ids`	string[]	No	(reference to CrmContact)
`company_ids`	string[]	No	(reference to CrmCompany)
`description`	string	No
`metadata`	CrmMetadata[]	No
`metadata[].id`	string	No
`metadata[].slug`	string	No
`metadata[].value`	object	No
`metadata[].namespace`	string	No
`metadata[].format`	enum	No	Values: `TEXT`, `NUMBER`, `DATE`, `BOOLEAN`, `FILE`, `TEXTAREA`, `SINGLE_SELECT`, `MULTIPLE_SELECT`, `MEASUREMENT`, `PRICE`, `YES_NO`, `CURRENCY`, `URL`
`metadata[].extra_data`	object	No

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'PUT',
  url: 'https://api.unified.to/crm/5de520f96e439b002043d8dc/deal/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.crm.updateCrmDeal({ connectionId, id, crmDeal: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'PUT',
  url: 'https://api.unified.to/crm/5de520f96e439b002043d8dc/deal/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("PUT", "https://api.unified.to/crm/5de520f96e439b002043d8dc/deal/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

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

url := `https://api.unified.to/crm/5de520f96e439b002043d8dc/deal/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("PUT", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

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

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

Python

import requests

url = "https://api.unified.to/crm/5de520f96e439b002043d8dc/deal/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.put(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/crm/5de520f96e439b002043d8dc/deal/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/crm/5de520f96e439b002043d8dc/deal/5de520f96e439b002043d8d8?fields=&raw=")

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

request = Net::HTTP::Put.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request PUT \
  --url 'https://api.unified.to/crm/5de520f96e439b002043d8dc/deal/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?