Update a company

PUT/crm/{connection_id}/company/{id}

Parameters

Payload

A company represents an organization that optionally is associated with a deal and/or contacts

idstring

Unique identifier for this company object

created_atdate-time

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

updated_atdate-time

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

namestring

The name of the company

deal_idsstring array

An array of deal IDs associated with this contact

contact_idsstring array

An array of contact IDs associated with this company

emails array

telephones array

websitesstring array

addressobject

is_activeboolean

tagsstring array

descriptionstring

industrystring

link_urlsstring array

Additional URLs associated with the contact e.g., LinkedIn, website, etc

employeesnumber

timezonestring

user_idstring

(reference to HrisEmployee)

metadata array

domainsstring array

raw

The raw data returned by the integration for this company

Returns

CrmCompany

Response field	Type	Required	Description
`id`	string	No	Unique identifier for this company object
`created_at`	string (date-time)	No	The date that this company object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	The last date that this company object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`name`	string	No	The name of the company
`deal_ids`	string[]	No	An array of deal IDs associated with this contact
`contact_ids`	string[]	No	An array of contact IDs associated with this company
`emails`	CrmEmail[]	No
`emails[].email`	string	No
`emails[].type`	enum	No	Values: `WORK`, `HOME`, `OTHER`
`telephones`	CrmTelephone[]	No
`telephones[].telephone`	string	Yes
`telephones[].type`	enum	No	Values: `WORK`, `HOME`, `OTHER`, `FAX`, `MOBILE`
`websites`	string[]	No
`address`	object	No
`address.address1`	string	No
`address.address2`	string	No
`address.city`	string	No
`address.region`	string	No
`address.region_code`	string	No
`address.postal_code`	string	No
`address.country`	string	No
`address.country_code`	string	No	ISO 2-digit country code
`is_active`	boolean	No
`tags`	string[]	No
`description`	string	No
`industry`	string	No
`link_urls`	string[]	No	Additional URLs associated with the contact e.g., LinkedIn, website, etc
`employees`	number	No
`timezone`	string	No
`user_id`	string	No	(reference to HrisEmployee)
`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
`domains`	string[]	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/company/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.updateCrmCompany({ connectionId, id, crmCompany: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'PUT',
  url: 'https://api.unified.to/crm/5de520f96e439b002043d8dc/company/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/company/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/company/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/company/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/company/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/company/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/company/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?