workOrders

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.

post/opportunities/{opportunity_id}/work-orders

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/opportunities/{opportunity_id}/work-orders
  • Auth: API key in header x-api-key

Path parameters

opportunity_idinteger required

Opportunity identifier

Request body

templateIdinteger required

The ID of the work order template to use

phaseInstanceIdinteger

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

idinteger

Created workflow element (task) identifier

createdAtstring date-time
updatedAtstring date-time
descriptionstring nullable
positioninteger

Position within phase

phaseInstanceIdinteger
projectIdinteger
createdByIdinteger

Changes

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