Home → Event Plugin → API Calls → api/PluginCreateCompany - Create a new Primary Record

1.3. api/PluginCreateCompany - Create a new Primary Record

This API call is used to create a new Primary Record (company) within the CRM.

Before Creating a New Primary Record

To avoid duplicate entries:

1. Capture the user’s Company Name or Postcode.
2. Use the api/PortalList call to search for existing matching records.
3. Present the user with options:
   • Select an existing Primary Record – if chosen, maintain the selected cid for use in api/PluginCreateContact.
   • "My Organisation Is Not Listed" – if chosen, proceed with the api/PluginCreateCompany call to create a new Primary Record.

 

---

 

Parameters To Submit

Fields marked with * are required and cannot be blank.

Parameter	Parameter Help	Parameter Data Type
Company*	Company name	String – Max 250 chars
CompanyTel*	Company telephone	String – Max 30 chars
CompanyEmail	Company email address	String – Max 250 chars
CompanyWeb	Company website URL (must start with http:// or https://)	String – Max 250 chars
Category*	Business category. Must pass ListValue, not ID	String – Provide ListValue from api/PortalList BusinessCategory.
Employees	Number of employees. Defaults to 1 if empty	Integer
CompanyAddress1*	First line of company address	String – Max 75 chars
CompanyAddress2	Second line of company address	String – Max 75 chars
CompanyAddress3	Third line of company address	String – Max 75 chars
CompanyAddress4*	Fourth line of company address	String – Max 75 chars
CompanyCounty*	County. Must pass ListValue, default to None if not selected	String – Provide ListValue from api/PortalList County.
CompanyPostcode*	Postcode of company address	String – Max 15 chars
CompanyCountry*	Country. Must pass ListValue, default to None if not selected	String – Provide ListValue from api/PortalList Country.
CompanyWhereHear*	How the company heard about you. Must pass ListValue, default to None if not selected	String – Provide ListValue from api/PortalList WhereHear.
API Key		String

 

---

 

Return Response

The API call ResponseMessage will return a range of fields. The following fields of data will be relevant for your purposes.

Field	Field Help
cid	Primary Record’s new cid that has just been created.
Company	New Primary Record's name.