Create Opportunity Work Order

Create a new work order for an opportunity.

Notes:

templateId is required.
phaseInstanceId is optional. The phase does not need to be started to create an opportunity work order.

Note: The /requests path is an alias for /opportunities and will continue to work until users are individually notified and migrated.

Create a new work order for an opportunity. Notes: - `templateId` is required. - `phaseInstanceId` is optional. The phase does not need to be started to create an opportunity work order. **Note:** The `/requests` path is an alias for `/opportunities` and will continue to work until users are individually notified and migrated.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

opportunity_idintegerRequired

Opportunity identifier

Request

This endpoint expects an object.

templateIdintegerRequired

The ID of the work order template to use

phaseInstanceIdintegerOptional

Optional. The ID of the phase instance to use. If provided, the phase does not need to be started to create an opportunity work order. You can gather phase instance ids from the get opportunity endpoint.

Response

Work order created successfully

idintegerOptional

Created workflow element (task) identifier

createdAtstringOptionalformat: "date-time"

updatedAtstringOptionalformat: "date-time"

descriptionstring or nullOptional

positionintegerOptional

Position within phase

phaseInstanceIdintegerOptional

projectIdintegerOptional

createdByIdintegerOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

1	const url = 'https://api.coperniq.io/v1/opportunities/1/work-orders';
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	"createdAt": "2024-01-15T09:30:00Z",
4	"updatedAt": "2024-01-15T09:30:00Z",
5	"description": "string",
6	"position": 1,
7	"phaseInstanceId": 1,
8	"projectId": 1,
9	"createdById": 1
10	}