Create Opportunity | Coperniq

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

accountIdinteger or nullOptional

ID of associated account

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

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

accountIdinteger or null

Associated account ID

addresslist of strings or null

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

citystring or null

confidencedouble or null

Deal confidence score (0-100)

createdAtstring or nullformat: "date-time"

Creation timestamp

createdByIdinteger or null

Identifier of the user who created the opportunity

custommap from strings to any or null

Custom fields

descriptionstring or null

Record description

geoLocationlist of strings or null

Latitude/Longitude in “lat,lon” format

idinteger or null

Unique identifier

imageUrlstring or null

Image URL for the opportunity

isActiveboolean or null

Whether the record is active

jurisdictionobject or null

lastActivitystring or nullformat: "date-time"

numberinteger or null

Sequential opportunity number

ownerobject or null

phaseobject or null

phaseIdinteger or null

phaseInstanceslist of objects or null

Ordered list of phase instances for the opportunity

primaryEmailstring or nullformat: "email"

Primary contact email

primaryPhonestring or null

Primary contact phone

projectManagerobject or null

salesRepobject or null

sizedouble or null

Deal size

statestring or null

streetstring or null

streetViewUrlstring or null

Street view image URL

titlestring or null

Record title/name

tradeslist of strings or null

Array of trade types

updatedAtstring or nullformat: "date-time"

Last update timestamp

valuedouble or null

Deal value

workflowIdinteger or null

Associated workflow ID

workflowNamestring or null

Name of the associated workflow.

zipcodestring or null

Errors

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	curl -X POST https://api.coperniq.io/v1/opportunities \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"body": {
6	"title": "City Center Mall Expansion",
7	"address": [
8	"123 Main St, Springfield, IL 62701"
9	],
10	"trades": [
11	"Carpentry",
12	"HVAC"
13	]
14	}
15	}'

1	{
2	"accountId": 34567,
3	"address": [
4	"123 Main St, Springfield, IL 62701"
5	],
6	"city": "Springfield",
7	"confidence": 85,
8	"createdAt": "2024-04-10T08:45:00Z",
9	"createdById": 102,
10	"custom": {},
11	"description": "Expansion project for the City Center Mall including new retail spaces and parking facilities.",
12	"geoLocation": [
13	"39.7817,-89.6501"
14	],
15	"id": 2048,
16	"imageUrl": "https://images.citycentermall.com/projects/2048/main.jpg",
17	"isActive": true,
18	"jurisdiction": {
19	"id": 20,
20	"name": "Springfield Building Authority",
21	"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
22	},
23	"lastActivity": "2024-04-09T16:30:00Z",
24	"number": 2048,
25	"owner": {
26	"id": 501,
27	"firstName": "Alice",
28	"lastName": "Johnson",
29	"email": "alice.johnson@citycentermall.com",
30	"phone": "+1-217-555-0101",
31	"avatarUrl": "https://avatars.citycentermall.com/users/501.jpg"
32	},
33	"phase": {
34	"id": 3,
35	"name": "Design Phase",
36	"type": "Planning"
37	},
38	"phaseId": 3,
39	"phaseInstances": [
40	{
41	"id": 301,
42	"name": "Initial Design",
43	"status": "IN_PROGRESS",
44	"position": 1,
45	"type": "Design",
46	"phaseTemplateId": 10,
47	"phaseTemplate": {
48	"id": 10,
49	"name": "Design Template",
50	"type": "Planning",
51	"redSla": 30,
52	"yellowSla": 15
53	}
54	}
55	],
56	"primaryEmail": "project.manager@citycentermall.com",
57	"primaryPhone": "+1-217-555-0199",
58	"projectManager": {
59	"id": 503,
60	"firstName": "Carol",
61	"lastName": "Davis",
62	"email": "carol.davis@citycentermall.com",
63	"phone": "+1-217-555-0122",
64	"avatarUrl": "https://avatars.citycentermall.com/users/503.jpg"
65	},
66	"salesRep": {
67	"id": 502,
68	"firstName": "Bob",
69	"lastName": "Smith",
70	"email": "bob.smith@coperniq.io",
71	"phone": "+1-217-555-0111",
72	"avatarUrl": "https://avatars.coperniq.io/users/502.jpg"
73	},
74	"size": 45000.75,
75	"state": "IL",
76	"street": "123 Main St",
77	"streetViewUrl": "https://maps.google.com/?q=123+Main+St,+Springfield,+IL+62701&layer=c",
78	"title": "City Center Mall Expansion",
79	"trades": [
80	"Carpentry",
81	"HVAC"
82	],
83	"updatedAt": "2024-04-10T08:45:00Z",
84	"value": 1250000.5,
85	"workflowId": 12,
86	"workflowName": "Standard Construction Workflow",
87	"zipcode": "62701"
88	}