v1

latestOpenAPI 3.0.02026-08-06100301483.8 KB

Entity

Adds a new Lead

If valid, the Lead will be created directly in Infinity.

Contact and Company Notes, and Job Description must not exceed the max upload size configured in Infinity.

A Photo must not exceed the max upload size configured in Infinity.

The max upload size can be retrieved from the /Reference/MaxUploadSize method (In KB).

The OwningConsultantId is optional, but if passed, it must be an active user id.

Only one of LinkedCompanyId and LinkedContactId can be passed for manual linking and must refer to a valid record on the database.

Automatic contact linking only occurs if both LinkedCompanyId and LinkedContactId are not supplied

Tags should be passed in as a comma-delimited string.

post/Entity/Lead

automaticallyLinkToContactsboolean required

Automatically link to active Infinity contacts

Descriptionstring nullable

Forenamestring nullable

Surnamestring nullable

ContactNotesstring nullable

JobTitlestring nullable

Companystring nullable

CompanyNotesstring nullable

PhoneNumberstring nullable

MobileNumberstring nullable

EmailAddressstring nullable

LinkedInUrlstring nullable

WebsiteUrlstring nullable

Addressstring nullable

Sourcestring nullable

Tagsstring nullable

OwningConsultantIdinteger nullable

LinkedCompanyIdinteger nullable

LinkedContactIdinteger nullable

ClientJobTitlestring nullable

JobDescriptionstring nullable

Photostring byte nullable

A Base64 image to display against the Lead

The image cannot exceed the max upload size configured in Infinity.

OK - Created ID

integer required