Create Opportunity Form

POST

https://api.coperniq.io/v1/opportunities/:opportunity_id/forms

Create a new form instance in an opportunity.

Notes:

templateId is required.
name is optional; defaults to the template’s name.
Opportunities cannot be assigned to a phase, so there is no phaseInstanceId field on this endpoint.

Create a new form instance in an opportunity. Notes: - `templateId` is required. - `name` is optional; defaults to the template's name. - Opportunities cannot be assigned to a phase, so there is no `phaseInstanceId` field on this endpoint.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

opportunity_idintegerRequired

Opportunity identifier

Request

This endpoint expects an object.

templateIdintegerRequired

Template to use for the form

namestringOptional

Optional. Name for the created form. Defaults to the template's name.

Response

Form created successfully

idintegerOptional

Created form identifier

templateIdintegerOptional

opportunityIdintegerOptional

typestringOptional

statusstringOptional

namestringOptional

createdAtstringOptionalformat: "date-time"

updatedAtstringOptionalformat: "date-time"

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

1	const url = 'https://api.coperniq.io/v1/opportunities/1/forms';
2	const options = {
3	method: 'POST',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{"templateId":1}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"id": 1,
3	"templateId": 1,
4	"opportunityId": 1,
5	"type": "string",
6	"status": "string",
7	"name": "string",
8	"createdAt": "2024-01-15T09:30:00Z",
9	"updatedAt": "2024-01-15T09:30:00Z"
10	}