Objects

Update a lead property

Update a single lead property by lead ID.

Overview

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

PATCH/api/crm/objects/leads/{leadId}

cURL

PATCH

bash

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

Authorization

Public API OAuth access token

crm.leads.write

Sample Request Body

json

{  "internal_name": "status",  "value": "qualified"}

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

leadIdintegerRequired

Lead ID.

Example: 55

Object	Description
leadId integer	RequiredLead ID. Example: 55

Request body

internal_namestringRequired

Property internal name to update.

Example: status

valueanyOptional

Scalar property value.

Example: qualified

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

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.