Opportunities

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/Opportunities/{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.

OPPORTUNITY_IDinteger
OPPORTUNITY_NAMEstring string required
OPPORTUNITY_DETAILSstring string
OPPORTUNITY_STATEstring string
RESPONSIBLE_USER_IDinteger
CATEGORY_IDinteger
IMAGE_URLstring string
BID_CURRENCYstring string
BID_AMOUNTnumber
BID_TYPEstring string
BID_DURATIONinteger
ACTUAL_CLOSE_DATEstring date-time
DATE_CREATED_UTCstring date-time
DATE_UPDATED_UTCstring date-time
OPPORTUNITY_VALUEnumber
PROBABILITYinteger
FORECAST_CLOSE_DATEstring date-time
OWNER_USER_IDinteger
LAST_ACTIVITY_DATE_UTCstring date-time
NEXT_ACTIVITY_DATE_UTCstring date-time
PIPELINE_IDinteger
STAGE_IDinteger
CREATED_USER_IDinteger
ORGANISATION_IDinteger
PRICEBOOK_IDinteger
LINKED_EMAIL_ADDRESSstring string

Changes

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