Leads

Adds a Lead

If you have trouble with creating a Lead, try creating Leads via the web interface, and then access those Leads via the API. This way you can see examples of the fields and sub-elements attached to the Lead. A common source of problems during write/update request is caused when users omit required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.

post/Leads

Request

  • Base URL
    https://api.insightly.com/v3.1
  • Auth
    none declared. Required headers: Authorization

Headers

Authorizationstring required

Authorization

Request body

LEAD_IDinteger required
SALUTATIONstring string
FIRST_NAMEstring string
LAST_NAMEstring string required
LEAD_SOURCE_IDinteger required
LEAD_STATUS_IDinteger required
TITLEstring string
EMAILstring string
EMPLOYEE_COUNTinteger
FAXstring string
INDUSTRYstring string
LEAD_DESCRIPTIONstring string
LEAD_RATINGinteger
MOBILEstring string
OWNER_USER_IDinteger
PHONEstring string
RESPONSIBLE_USER_IDinteger
WEBSITEstring string
ADDRESS_STREETstring string
ADDRESS_CITYstring string
ADDRESS_STATEstring string
ADDRESS_POSTCODEstring string
ADDRESS_COUNTRYstring string
ORGANISATION_NAMEstring string
EMAIL_OPTED_OUTboolean

Response

Request succeeded.

LEAD_IDinteger required
SALUTATIONstring string
FIRST_NAMEstring string
LAST_NAMEstring string required
LEAD_SOURCE_IDinteger required
LEAD_STATUS_IDinteger required
TITLEstring string
CONVERTEDboolean
CONVERTED_CONTACT_IDinteger
CONVERTED_DATE_UTCstring date-time
CONVERTED_OPPORTUNITY_IDinteger
CONVERTED_ORGANISATION_IDinteger
DATE_CREATED_UTCstring date-time
DATE_UPDATED_UTCstring date-time
EMAILstring string
EMPLOYEE_COUNTinteger
FAXstring string
INDUSTRYstring string
LEAD_DESCRIPTIONstring string
LEAD_RATINGinteger
MOBILEstring string
OWNER_USER_IDinteger
PHONEstring string
RESPONSIBLE_USER_IDinteger
WEBSITEstring string
ADDRESS_STREETstring string
ADDRESS_CITYstring string
ADDRESS_STATEstring string
ADDRESS_POSTCODEstring string
ADDRESS_COUNTRYstring string
LAST_ACTIVITY_DATE_UTCstring date-time
NEXT_ACTIVITY_DATE_UTCstring date-time
ORGANISATION_NAMEstring string
CREATED_USER_IDinteger
IMAGE_URLstring string
EMAIL_OPTED_OUTboolean
LINKED_EMAIL_ADDRESSstring string

Changes

No recorded changes to this operation across all 1 revision of this API.