Appearance
Create a company
POST
/api/nova/companies
Creates a new company from the request body. Supported fields include name, description, website, email, phone, faxNo, linkedIn, facebook, twitter, domain, employeeCount, annualRevenue, foundedYear, client flag, rating, statusId and customFields (user-defined fields referenced by fieldId). The account's company record limit is checked first and a 429 is returned if it has been reached. A company whose name already exists in the account (case-insensitive) is not created; the response is 409 with error DUPLICATE and the existing company's ID in the data field. On success the response contains the ID of the newly created company.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "annualRevenue": 0, "client": true, "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "domain": "string", "email": "string", "employeeCount": 0, "facebook": "string", "faxNo": "string", "foundedYear": 0, "id": "string", "linkedIn": "string", "name": "string", "ownerId": "string", "phone": "string", "rating": 0, "statusId": "string", "tags": [ { "group": "string", "value": "string" } ], "twitter": "string", "website": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "requestId": "string", "success": true
{
}