---
title: "Generates a new Merge Document"
method: POST
path: "/Opportunities/{id}/MergeDocument/{documentTemplateId}"
tags: ["Opportunities"]
---

# Generates a new Merge Document

`POST /Opportunities/{id}/MergeDocument/{documentTemplateId}`

## Request

- Base URL: `https://api.insightly.com/v3.1`
- URL: `https://api.insightly.com/v3.1/Opportunities/{id}/MergeDocument/{documentTemplateId}`
- Auth: none declared. Required headers: `Authorization`

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

## Path parameters

- `id` integer, required
- `documentTemplateId` integer, required

## Query parameters

- `format` string

## Headers

- `Authorization` string, required

## Response `200`

Request succeeded.

- object[]
  - `OPPORTUNITY_ID` integer
  - `OPPORTUNITY_NAME` string, string, required
  - `OPPORTUNITY_DETAILS` string, string
  - `OPPORTUNITY_STATE` string, string
  - `RESPONSIBLE_USER_ID` integer
  - `CATEGORY_ID` integer
  - `IMAGE_URL` string, string
  - `BID_CURRENCY` string, string
  - `BID_AMOUNT` number
  - `BID_TYPE` string, string
  - `BID_DURATION` integer
  - `ACTUAL_CLOSE_DATE` string, date-time
  - `DATE_CREATED_UTC` string, date-time
  - `DATE_UPDATED_UTC` string, date-time
  - `OPPORTUNITY_VALUE` number
  - `PROBABILITY` integer
  - `FORECAST_CLOSE_DATE` string, date-time
  - `OWNER_USER_ID` integer
  - `LAST_ACTIVITY_DATE_UTC` string, date-time
  - `NEXT_ACTIVITY_DATE_UTC` string, date-time
  - `PIPELINE_ID` integer
  - `STAGE_ID` integer
  - `CREATED_USER_ID` integer
  - `ORGANISATION_ID` integer
  - `PRICEBOOK_ID` integer
  - `CUSTOMFIELDS` APICustomField[]
    - `FIELD_NAME` string
    - `FIELD_VALUE` object
  - `TAGS` APITag[]
    - `TAG_NAME` string
  - `LINKS` APILinkDto[]
    - `LINK_ID` integer
    - `OBJECT_NAME` string
    - `OBJECT_ID` integer
    - `LINK_OBJECT_NAME` string
    - `LINK_OBJECT_ID` integer
    - `ROLE` string
    - `DETAILS` string
    - `RELATIONSHIP_ID` integer
    - `IS_FORWARD` boolean
  - `LINKED_EMAIL_ADDRESS` string, string

## Other responses

- `400`: Often missing or invalid parameter.
- `401`: Authentication failed.
- `403`: API User does not have access to Document Template.
- `404`: Record not found.

---

[API](https://skmtc.dev/insightly/apis/insightly-api-v3-1.md) - [All operations](https://skmtc.dev/insightly/apis/insightly-api-v3-1/llms.txt) - [OpenAPI document](https://skmtc.dev/insightly/apis/insightly-api-v3-1/revisions/e7df0c3b65fb?raw)