Appearance
Create a lead
POST
/api/nova/leads
Creates a new lead record. The request body accepts name, email and phone details, job title, company name, social links, website, description, employees, rating and a do-not-contact flag, plus statusId, sourceId, industryId, sectorId and custom UDF fields, all of which are resolved against the account's master data. Creation is subject to the account's API usage limits and returns 429 when the limit is exceeded. A duplicate check runs before the record is created: an existing lead matching on email, LinkedIn profile, or name and company combination blocks the create and responds with 409, carrying the existing record's ID in the data field so it can be updated instead. Contacts are included in that check unless the account allows contacts as leads. On success the new lead's id is returned. Responds with 401 if the API key is invalid.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "alternateEmail": "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", "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
{
}