Update a deal
curl --request PATCH \
--url https://app.alvahq.com/api/v1/deal/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "",
"companyId": "",
"primaryContactId": "",
"ownerId": "",
"stage": "",
"methodology": "",
"value": "",
"probability": "",
"expectedCloseDate": "",
"notes": "",
"customFields": {}
}
'import requests
url = "https://app.alvahq.com/api/v1/deal/{id}"
payload = {
"name": "",
"companyId": "",
"primaryContactId": "",
"ownerId": "",
"stage": "",
"methodology": "",
"value": "",
"probability": "",
"expectedCloseDate": "",
"notes": "",
"customFields": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '',
companyId: '',
primaryContactId: '',
ownerId: '',
stage: '',
methodology: '',
value: '',
probability: '',
expectedCloseDate: '',
notes: '',
customFields: {}
})
};
fetch('https://app.alvahq.com/api/v1/deal/{id}', 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://app.alvahq.com/api/v1/deal/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '',
'companyId' => '',
'primaryContactId' => '',
'ownerId' => '',
'stage' => '',
'methodology' => '',
'value' => '',
'probability' => '',
'expectedCloseDate' => '',
'notes' => '',
'customFields' => [
]
]),
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://app.alvahq.com/api/v1/deal/{id}"
payload := strings.NewReader("{\n \"name\": \"\",\n \"companyId\": \"\",\n \"primaryContactId\": \"\",\n \"ownerId\": \"\",\n \"stage\": \"\",\n \"methodology\": \"\",\n \"value\": \"\",\n \"probability\": \"\",\n \"expectedCloseDate\": \"\",\n \"notes\": \"\",\n \"customFields\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.alvahq.com/api/v1/deal/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"\",\n \"companyId\": \"\",\n \"primaryContactId\": \"\",\n \"ownerId\": \"\",\n \"stage\": \"\",\n \"methodology\": \"\",\n \"value\": \"\",\n \"probability\": \"\",\n \"expectedCloseDate\": \"\",\n \"notes\": \"\",\n \"customFields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.alvahq.com/api/v1/deal/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"\",\n \"companyId\": \"\",\n \"primaryContactId\": \"\",\n \"ownerId\": \"\",\n \"stage\": \"\",\n \"methodology\": \"\",\n \"value\": \"\",\n \"probability\": \"\",\n \"expectedCloseDate\": \"\",\n \"notes\": \"\",\n \"customFields\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Enterprise SaaS Deal",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primaryContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage": "discovery",
"methodology": "meddpicc",
"value": "50000.00",
"probability": "75",
"expectedCloseDate": "2023-11-07T05:31:56Z",
"actualCloseDate": "2023-11-07T05:31:56Z",
"notes": "<string>",
"customFields": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"resource": "<string>"
}{
"error": "Unauthorised",
"message": "Invalid or revoked API key"
}{
"error": "Not Found",
"message": "Company with id 'xxx' not found"
}{
"error": "Unprocessable Entity",
"message": "Validation failed",
"details": {
"name": [
"Name is required"
]
}
}Deals
Update a deal
PATCH
/
api
/
v1
/
deal
/
{id}
Update a deal
curl --request PATCH \
--url https://app.alvahq.com/api/v1/deal/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "",
"companyId": "",
"primaryContactId": "",
"ownerId": "",
"stage": "",
"methodology": "",
"value": "",
"probability": "",
"expectedCloseDate": "",
"notes": "",
"customFields": {}
}
'import requests
url = "https://app.alvahq.com/api/v1/deal/{id}"
payload = {
"name": "",
"companyId": "",
"primaryContactId": "",
"ownerId": "",
"stage": "",
"methodology": "",
"value": "",
"probability": "",
"expectedCloseDate": "",
"notes": "",
"customFields": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '',
companyId: '',
primaryContactId: '',
ownerId: '',
stage: '',
methodology: '',
value: '',
probability: '',
expectedCloseDate: '',
notes: '',
customFields: {}
})
};
fetch('https://app.alvahq.com/api/v1/deal/{id}', 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://app.alvahq.com/api/v1/deal/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '',
'companyId' => '',
'primaryContactId' => '',
'ownerId' => '',
'stage' => '',
'methodology' => '',
'value' => '',
'probability' => '',
'expectedCloseDate' => '',
'notes' => '',
'customFields' => [
]
]),
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://app.alvahq.com/api/v1/deal/{id}"
payload := strings.NewReader("{\n \"name\": \"\",\n \"companyId\": \"\",\n \"primaryContactId\": \"\",\n \"ownerId\": \"\",\n \"stage\": \"\",\n \"methodology\": \"\",\n \"value\": \"\",\n \"probability\": \"\",\n \"expectedCloseDate\": \"\",\n \"notes\": \"\",\n \"customFields\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.alvahq.com/api/v1/deal/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"\",\n \"companyId\": \"\",\n \"primaryContactId\": \"\",\n \"ownerId\": \"\",\n \"stage\": \"\",\n \"methodology\": \"\",\n \"value\": \"\",\n \"probability\": \"\",\n \"expectedCloseDate\": \"\",\n \"notes\": \"\",\n \"customFields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.alvahq.com/api/v1/deal/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"\",\n \"companyId\": \"\",\n \"primaryContactId\": \"\",\n \"ownerId\": \"\",\n \"stage\": \"\",\n \"methodology\": \"\",\n \"value\": \"\",\n \"probability\": \"\",\n \"expectedCloseDate\": \"\",\n \"notes\": \"\",\n \"customFields\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Enterprise SaaS Deal",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primaryContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage": "discovery",
"methodology": "meddpicc",
"value": "50000.00",
"probability": "75",
"expectedCloseDate": "2023-11-07T05:31:56Z",
"actualCloseDate": "2023-11-07T05:31:56Z",
"notes": "<string>",
"customFields": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"resource": "<string>"
}{
"error": "Unauthorised",
"message": "Invalid or revoked API key"
}{
"error": "Not Found",
"message": "Company with id 'xxx' not found"
}{
"error": "Unprocessable Entity",
"message": "Validation failed",
"details": {
"name": [
"Name is required"
]
}
}Authorizations
API key from Settings > Developer. Format: alva_sk_...
Path Parameters
The deal ID
Body
application/json
All fields are optional — send only the properties you want to update. In the interactive playground (the "Test Request" panel) the JSON body is fully editable; type over any value and delete the properties you don't need. Blank fields are ignored.
All fields are optional. Only included fields will be updated.
Available options:
discovery, qualification, proposal, negotiation, closed_won, closed_lost Available options:
meddpicc, bant, spiced