Leads

Generates a new Merge Document

Returns the generated document. If the 'format' parameter is set to 'JSON', returns the metadata of the associated File Attachment in JSON format.

post/Leads/{id}/MergeDocument/{documentTemplateId}

Request

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

Path parameters

idinteger required

A Record's ID (RECORD_ID)

documentTemplateIdinteger required

A Document Template Id

Query parameters

formatstring

Binary(default) or JSON

Headers

Authorizationstring required

Authorization

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.