Appearance
Create a contact
POST
/api/nova/contacts
Creates a new contact from the request body. Supported fields include firstName, lastName, email, alternateEmail, mobile, homePhone, workPhone, jobTitle, companyId, secondaryCompanyId, ownerId, tags, linkedIn, facebook, twitter, skype, dateOfBirth, description, internalNotes, skills, statusId, sourceId and customFields (user-defined fields referenced by fieldId). The account's contact record limit is checked first and a 429 is returned if it has been reached. A duplicate check runs before the record is created: an existing contact matching on email, LinkedIn profile, or first name, surname and company combination blocks the create and responds with 409, carrying the existing contact's ID in the data field so it can be updated instead. On success the response contains the ID of the newly created contact.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "alternateEmail": "string", "companyId": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "dateOfBirth": "string", "description": "string", "email": "string", "facebook": "string", "firstName": "string", "homePhone": "string", "id": "string", "internalNotes": "string", "jobTitle": "string", "lastName": "string", "linkedIn": "string", "mobile": "string", "ownerId": "string", "secondaryCompanyId": "string", "skills": [ "string" ], "skype": "string", "sourceId": "string", "statusId": "string", "tags": [ { "group": "string", "value": "string" } ], "twitter": "string", "workPhone": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "requestId": "string", "success": true
{
}