Create a deal
POST/crm/{connection_id}/deal
Creates a CrmDeal. Provide the unified CrmDeal fields in the request body; they are mapped to the provider's API. Returns the created CrmDeal.
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
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)
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
Returns
| 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 | The ID of the custom field definition (from the metadata/metadata endpoint). |
metadata[].slug | string | No | The integration's API name of an existing custom field (e.g. Region__c in Salesforce). List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration. |
metadata[].value | object | No | The field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string. |
metadata[].namespace | string | No | |
metadata[].format | enum | No | The data type of the custom field, which determines how value is formatted. 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: 'POST',
url: 'https://api.unified.to/crm/5de520f96e439b002043d8dc/deal',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know
Was this page helpful?