crm
deal

Update a deal

Changed on
patch/crm/{connection_id}/deal/{id}

Request

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

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Deal

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
rawobject

The raw data returned by the integration for this deal

Response

Successful

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
rawobject

The raw data returned by the integration for this deal

Changes

  • 3bea28547cc7Revision changes
    • breaking

      removed the enum value pipeline from the property items/ of the query request parameter fields

    • breaking

      removed the enum value pipeline_id from the property items/ of the query request parameter fields

    • breaking

      removed the enum value stage from the property items/ of the query request parameter fields

    • breaking

      removed the enum value stage_id from the property items/ of the query request parameter fields

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the enum value description to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status