Opportunities
Create an opportunity
Create a deal/opportunity. Fires deal_created (and deal_won / deal_lost when created with a terminal status). Falls back to the default pipeline when pipeline_id is omitted.
POST
/
opportunities
Create an opportunity
curl --request POST \
--url https://api.smartlyq.com/v1/opportunities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"contact_email": "[email protected]",
"company": "<string>",
"value": 123,
"pipeline_id": 123,
"stage": "<string>",
"status": "open",
"assigned_user_id": 123,
"next_action_date": "2023-12-25",
"notes": "<string>"
}
'import requests
url = "https://api.smartlyq.com/v1/opportunities"
payload = {
"name": "<string>",
"contact_email": "[email protected]",
"company": "<string>",
"value": 123,
"pipeline_id": 123,
"stage": "<string>",
"status": "open",
"assigned_user_id": 123,
"next_action_date": "2023-12-25",
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
contact_email: '[email protected]',
company: '<string>',
value: 123,
pipeline_id: 123,
stage: '<string>',
status: 'open',
assigned_user_id: 123,
next_action_date: '2023-12-25',
notes: '<string>'
})
};
fetch('https://api.smartlyq.com/v1/opportunities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.smartlyq.com/v1/opportunities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'contact_email' => '[email protected]',
'company' => '<string>',
'value' => 123,
'pipeline_id' => 123,
'stage' => '<string>',
'status' => 'open',
'assigned_user_id' => 123,
'next_action_date' => '2023-12-25',
'notes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.smartlyq.com/v1/opportunities"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"contact_email\": \"[email protected]\",\n \"company\": \"<string>\",\n \"value\": 123,\n \"pipeline_id\": 123,\n \"stage\": \"<string>\",\n \"status\": \"open\",\n \"assigned_user_id\": 123,\n \"next_action_date\": \"2023-12-25\",\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.smartlyq.com/v1/opportunities")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"contact_email\": \"[email protected]\",\n \"company\": \"<string>\",\n \"value\": 123,\n \"pipeline_id\": 123,\n \"stage\": \"<string>\",\n \"status\": \"open\",\n \"assigned_user_id\": 123,\n \"next_action_date\": \"2023-12-25\",\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smartlyq.com/v1/opportunities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"contact_email\": \"[email protected]\",\n \"company\": \"<string>\",\n \"value\": 123,\n \"pipeline_id\": 123,\n \"stage\": \"<string>\",\n \"status\": \"open\",\n \"assigned_user_id\": 123,\n \"next_action_date\": \"2023-12-25\",\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": 512034,
"pipeline_id": 3121,
"name": "Acme annual plan",
"contact_email": "[email protected]",
"company": "Acme Corp",
"value": 2500,
"stage": "proposal",
"status": "open",
"assigned_user_id": null,
"created_at": "2026-07-01T10:15:00Z"
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Missing required fields: content, platforms.",
"details": {
"fields": [
"content",
"platforms"
]
}
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}Authorizations
API key from Developer dashboard (Bearer token).
Body
application/json
Opportunity / deal name.
Monetary value.
Stage key within the pipeline.
Available options:
open, won, lost, abandoned ⌘I
Create an opportunity
curl --request POST \
--url https://api.smartlyq.com/v1/opportunities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"contact_email": "[email protected]",
"company": "<string>",
"value": 123,
"pipeline_id": 123,
"stage": "<string>",
"status": "open",
"assigned_user_id": 123,
"next_action_date": "2023-12-25",
"notes": "<string>"
}
'import requests
url = "https://api.smartlyq.com/v1/opportunities"
payload = {
"name": "<string>",
"contact_email": "[email protected]",
"company": "<string>",
"value": 123,
"pipeline_id": 123,
"stage": "<string>",
"status": "open",
"assigned_user_id": 123,
"next_action_date": "2023-12-25",
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
contact_email: '[email protected]',
company: '<string>',
value: 123,
pipeline_id: 123,
stage: '<string>',
status: 'open',
assigned_user_id: 123,
next_action_date: '2023-12-25',
notes: '<string>'
})
};
fetch('https://api.smartlyq.com/v1/opportunities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.smartlyq.com/v1/opportunities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'contact_email' => '[email protected]',
'company' => '<string>',
'value' => 123,
'pipeline_id' => 123,
'stage' => '<string>',
'status' => 'open',
'assigned_user_id' => 123,
'next_action_date' => '2023-12-25',
'notes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.smartlyq.com/v1/opportunities"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"contact_email\": \"[email protected]\",\n \"company\": \"<string>\",\n \"value\": 123,\n \"pipeline_id\": 123,\n \"stage\": \"<string>\",\n \"status\": \"open\",\n \"assigned_user_id\": 123,\n \"next_action_date\": \"2023-12-25\",\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.smartlyq.com/v1/opportunities")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"contact_email\": \"[email protected]\",\n \"company\": \"<string>\",\n \"value\": 123,\n \"pipeline_id\": 123,\n \"stage\": \"<string>\",\n \"status\": \"open\",\n \"assigned_user_id\": 123,\n \"next_action_date\": \"2023-12-25\",\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smartlyq.com/v1/opportunities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"contact_email\": \"[email protected]\",\n \"company\": \"<string>\",\n \"value\": 123,\n \"pipeline_id\": 123,\n \"stage\": \"<string>\",\n \"status\": \"open\",\n \"assigned_user_id\": 123,\n \"next_action_date\": \"2023-12-25\",\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": 512034,
"pipeline_id": 3121,
"name": "Acme annual plan",
"contact_email": "[email protected]",
"company": "Acme Corp",
"value": 2500,
"stage": "proposal",
"status": "open",
"assigned_user_id": null,
"created_at": "2026-07-01T10:15:00Z"
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Missing required fields: content, platforms.",
"details": {
"fields": [
"content",
"platforms"
]
}
},
"meta": {
"request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
"timestamp": "2026-07-26T09:41:22Z"
}
}
