crm

deal

Create a deal

post/crm/{connection_id}/deal

Request

Base URL: http://api.unified.to
URL: http://api.unified.to/crm/{connection_id}/deal
Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

fieldsstring[]

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

Request body

idstring

Unique identifier for this deal object

created_atstring date-time

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

updated_atstring date-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_atstring date-time

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

closing_atstring date-time

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

sourcestring

The source for this deal

probabilitynumber

tagsstring[]

lost_reasonstring

won_reasonstring

user_idstring

(reference to HrisEmployee)

contact_idsstring[]

company_idsstring[]

descriptionstring

rawunknown

Response

Successful