Objects

Update a deal property

Update a single deal property by deal ID.

Overview

Use this endpoint to replace one property value on an existing deal. It requires public api oauth access token authentication and the crm.deals.write scope.

PATCH/api/crm/objects/deals/{dealId}

cURL

PATCH

bash

curl --request PATCH \  --url 'https://crm.notifyy.io/api/crm/objects/deals/55' \  --header 'Authorization: Bearer nfy_public_api_access_token' \  --header 'Content-Type: application/json' \  --data '{  "internal_name": "amount",  "value": "15000"}'

Authorization

Public API OAuth access token

crm.deals.write

Sample Request Body

json

{  "internal_name": "amount",  "value": "15000"}

Sample Response

json

{  "success": true,  "message": "Property updated successfully",  "data": null}

Status Codes

Code	Description
200	Property was updated.

Headers

AuthorizationstringRequired

Public API OAuth bearer token.

Example: Bearer nfy_public_api_access_token

Content-TypestringRequired

Request body media type.

Example: application/json

Object	Description
Authorization string	RequiredPublic API OAuth bearer token. Example: Bearer nfy_public_api_access_token
Content-Type string	RequiredRequest body media type. Example: application/json

Path parameters

dealIdintegerRequired

Deal ID.

Example: 55

Object	Description
dealId integer	RequiredDeal ID. Example: 55

Request body

internal_namestringRequired

Property internal name to update.

Example: amount

valueanyOptional

Scalar property value.

Example: 15000

Object	Description
internal_name string	RequiredProperty internal name to update. Example: amount
value any	OptionalScalar property value. Example: 15000

Response fields

datanull

No response payload is returned for a successful property update.

Object	Description
data null	No response payload is returned for a successful property update.