Create Opportunity | Coperniq API

Create a new opportunity with required and optional fields.

Required fields:

title: Opportunity title/name
address: Opportunity location
trades: Array of trade types

Optional fields:

accountId: Link to existing account
workflowId: Link to workflow
phaseId: Link to phase
value: Opportunity value
size: Opportunity size
confidence: Confidence score (0-100)
primaryEmail/primaryPhone: Contact information
contacts: Contact IDs only (no name, email, phone, etc.). The contacts must be created first via POST /contacts.
custom: Custom fields object

Note: If primaryEmail or primaryPhone is provided, a contact will be automatically created or matched.

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

Create a new opportunity with required and optional fields. Required fields: - `title`: Opportunity title/name - `address`: Opportunity location - `trades`: Array of trade types Optional fields: - `accountId`: Link to existing account - `workflowId`: Link to workflow - `phaseId`: Link to phase - `value`: Opportunity value - `size`: Opportunity size - `confidence`: Confidence score (0-100) - `primaryEmail`/`primaryPhone`: Contact information - `contacts`: Contact IDs only (no name, email, phone, etc.). The contacts must be created first via POST /contacts. - `custom`: Custom fields object Note: If primaryEmail or primaryPhone is provided, a contact will be automatically created or matched. **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

Query parameters

allow_new_optionsbooleanOptionalDefaults to false

Whether to allow creation of new dropdown options during record creation

match_byenumOptionalDefaults to title

Field to use for matching existing records

Allowed values:

match_found_strategyenumOptionalDefaults to skip

Strategy to use when a match is found

Allowed values:

Request

This endpoint expects an object.

titlestringRequired

Opportunity title/name

addresslist of stringsRequired

An array containing a single string, which represents the full opportunity location/address.

tradeslist of stringsRequired

Array of trade types

descriptionstring or nullOptional

Opportunity description

workflowIdinteger or nullOptional

ID of associated workflow

valuedoubleOptional

Project value

sizedoubleOptional

Project size

statusenumOptional

Status of the project:

ACTIVE - Project is active and in progress
ON_HOLD - Project is temporarily paused
CANCELLED - Project has been cancelled
COMPLETED - Project has been completed

Allowed values:

primaryEmailstringOptionalformat: "email"

Primary contact email

primaryPhonestringOptional

Primary contact phone

contactslist of integersOptional

Contact IDs only (no name, email, phone, etc.). The contacts must be created first via POST /contacts.

custommap from strings to anyOptional

Custom fields

Response

Matching opportunity found

idinteger

Unique identifier

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

titlestring

Record title/name

descriptionstring or null

Record description

addresslist of strings

An array containing a single string, which represents the full opportunity location/address.

isActiveboolean

Whether the record is active

primaryEmailstring or nullformat: "email"

Primary contact email

primaryPhonestring or null

Primary contact phone

numberinteger

Sequential opportunity number

custommap from strings to any

Custom fields

tradeslist of strings

Array of trade types

valuedouble or null

Deal value

sizedouble or null

Deal size

confidencedouble or null

Deal confidence score (0-100)

workflowIdinteger or null

Associated workflow ID

accountIdinteger or null

Associated account ID

createdByIdinteger

Identifier of the user who created the opportunity

geoLocationlist of strings

Latitude/Longitude in “lat,lon” format

imageUrlstring or null

Image URL for the opportunity

streetViewUrlstring or null

Street view image URL

citystring

zipcodestring

statestring

streetstring

phaseobject or null

phaseInstanceslist of objects

Ordered list of phase instances for the opportunity

ownerobject or null

salesRepobject or null

projectManagerobject or null

jurisdictionobject or null

lastActivitystring or nullformat: "date-time"

phaseIdinteger or null

workflowNamestring

Name of the associated workflow.

Errors

400

Bad Request Error

401

Unauthorized Error

Create a new opportunity with required and optional fields.

Required fields:

title: Opportunity title/name
address: Opportunity location
trades: Array of trade types

Optional fields:

accountId: Link to existing account
workflowId: Link to workflow
phaseId: Link to phase
value: Opportunity value
size: Opportunity size
confidence: Confidence score (0-100)
primaryEmail/primaryPhone: Contact information
contacts: Contact IDs only (no name, email, phone, etc.). The contacts must be created first via POST /contacts.
custom: Custom fields object

Note: If primaryEmail or primaryPhone is provided, a contact will be automatically created or matched.

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

1	const url = 'https://api.coperniq.io/v1/opportunities';
2	const options = {
3	method: 'POST',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{"title":"string","address":["1600 Pennsylvania Ave NW, Washington, DC 20500"],"trades":["string"]}'
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	"title": "string",
6	"description": "string",
7	"address": [
8	"string"
9	],
10	"isActive": true,
11	"primaryEmail": "string",
12	"primaryPhone": "string",
13	"number": 1,
14	"custom": {},
15	"trades": [
16	"string"
17	],
18	"value": 1.1,
19	"size": 1.1,
20	"confidence": 1.1,
21	"workflowId": 1,
22	"accountId": 1,
23	"createdById": 1,
24	"geoLocation": [
25	"string"
26	],
27	"imageUrl": "string",
28	"streetViewUrl": "string",
29	"city": "string",
30	"zipcode": "string",
31	"state": "string",
32	"street": "string",
33	"phase": {
34	"id": 1,
35	"name": "string",
36	"type": "string"
37	},
38	"phaseInstances": [
39	{
40	"id": 1,
41	"name": "string",
42	"status": "NOT_STARTED",
43	"position": 1,
44	"type": "string",
45	"phaseTemplateId": 1,
46	"phaseTemplate": {
47	"id": 1,
48	"name": "string",
49	"type": "string",
50	"redSla": 1,
51	"yellowSla": 1
52	}
53	}
54	],
55	"owner": {
56	"id": 1,
57	"firstName": "string",
58	"lastName": "string",
59	"email": "string",
60	"phone": "string",
61	"avatarUrl": "string"
62	},
63	"salesRep": {
64	"id": 1,
65	"firstName": "string",
66	"lastName": "string",
67	"email": "string",
68	"phone": "string",
69	"avatarUrl": "string"
70	},
71	"projectManager": {
72	"id": 1,
73	"firstName": "string",
74	"lastName": "string",
75	"email": "string",
76	"phone": "string",
77	"avatarUrl": "string"
78	},
79	"jurisdiction": {
80	"id": 1,
81	"name": "string",
82	"uuid": "string"
83	},
84	"lastActivity": "2024-01-15T09:30:00Z",
85	"phaseId": 1,
86	"workflowName": "string"
87	}