Appearance
Update a lead
PUT
/api/nova/leads/{leadId}
Updates an existing lead identified by the path id. Fields supplied in the request body overwrite the existing values and most omitted fields are left unchanged, although the doNotContact flag is always applied and defaults to false when omitted. The statusId, sourceId, industryId and sectorId fields are resolved against the account's master data, and custom UDF fields replace the stored custom field values when provided. Returns 404 when the lead is not found and the lead id on success. Responds with 401 for an invalid API key and 429 when API usage limits are exceeded.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
leadId*
leadId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "alternateEmail": "string", "companyId": "string", "companyName": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "doNotContact": true, "email": "string", "employees": "string", "facebook": "string", "firstName": "string", "fromContactId": "string", "homePhone": "string", "id": "string", "industryId": "string", "jobTitle": "string", "lastName": "string", "linkedIn": "string", "mobile": "string", "ownerId": "string", "rating": 0, "sectorId": "string", "sourceId": "string", "statusId": "string", "tags": [ { "group": "string", "value": "string" } ], "twitter": "string", "website": "string", "workPhone": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "requestId": "string", "success": true
{
}