Create Proposal
curl --request POST \
--url https://api.example.com/proposals \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientName": "<string>",
"clientLocation": "<string>",
"currency": "USD",
"hourlyRate": "50.00",
"requirements": [],
"settings": {},
"total": 123
}
'import requests
url = "https://api.example.com/proposals"
payload = {
"name": "<string>",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientName": "<string>",
"clientLocation": "<string>",
"currency": "USD",
"hourlyRate": "50.00",
"requirements": [],
"settings": {},
"total": 123
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
templateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
clientName: '<string>',
clientLocation: '<string>',
currency: 'USD',
hourlyRate: '50.00',
requirements: [],
settings: {},
total: 123
})
};
fetch('https://api.example.com/proposals', 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.example.com/proposals",
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>',
'templateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'clientName' => '<string>',
'clientLocation' => '<string>',
'currency' => 'USD',
'hourlyRate' => '50.00',
'requirements' => [
],
'settings' => [
],
'total' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.example.com/proposals"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientName\": \"<string>\",\n \"clientLocation\": \"<string>\",\n \"currency\": \"USD\",\n \"hourlyRate\": \"50.00\",\n \"requirements\": [],\n \"settings\": {},\n \"total\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.example.com/proposals")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientName\": \"<string>\",\n \"clientLocation\": \"<string>\",\n \"currency\": \"USD\",\n \"hourlyRate\": \"50.00\",\n \"requirements\": [],\n \"settings\": {},\n \"total\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/proposals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientName\": \"<string>\",\n \"clientLocation\": \"<string>\",\n \"currency\": \"USD\",\n \"hourlyRate\": \"50.00\",\n \"requirements\": [],\n \"settings\": {},\n \"total\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"clientName": "<string>",
"clientLocation": "<string>",
"currency": "<string>",
"hourlyRate": "<string>",
"requirements": [
{}
],
"settings": {},
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total": "<string>",
"outcome": "<string>",
"outcomeAt": "2023-11-07T05:31:56Z",
"outcomeReason": "<string>",
"outcomeNotes": "<string>",
"outcomeValue": "<string>",
"authorName": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Proposals
Create Proposal
Create a new proposal.
Required scope: write
Note: This endpoint does not check quota limits when using API keys.
POST
/
proposals
Create Proposal
curl --request POST \
--url https://api.example.com/proposals \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientName": "<string>",
"clientLocation": "<string>",
"currency": "USD",
"hourlyRate": "50.00",
"requirements": [],
"settings": {},
"total": 123
}
'import requests
url = "https://api.example.com/proposals"
payload = {
"name": "<string>",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientName": "<string>",
"clientLocation": "<string>",
"currency": "USD",
"hourlyRate": "50.00",
"requirements": [],
"settings": {},
"total": 123
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
templateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
clientName: '<string>',
clientLocation: '<string>',
currency: 'USD',
hourlyRate: '50.00',
requirements: [],
settings: {},
total: 123
})
};
fetch('https://api.example.com/proposals', 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.example.com/proposals",
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>',
'templateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'clientName' => '<string>',
'clientLocation' => '<string>',
'currency' => 'USD',
'hourlyRate' => '50.00',
'requirements' => [
],
'settings' => [
],
'total' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.example.com/proposals"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientName\": \"<string>\",\n \"clientLocation\": \"<string>\",\n \"currency\": \"USD\",\n \"hourlyRate\": \"50.00\",\n \"requirements\": [],\n \"settings\": {},\n \"total\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.example.com/proposals")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientName\": \"<string>\",\n \"clientLocation\": \"<string>\",\n \"currency\": \"USD\",\n \"hourlyRate\": \"50.00\",\n \"requirements\": [],\n \"settings\": {},\n \"total\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/proposals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientName\": \"<string>\",\n \"clientLocation\": \"<string>\",\n \"currency\": \"USD\",\n \"hourlyRate\": \"50.00\",\n \"requirements\": [],\n \"settings\": {},\n \"total\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"clientName": "<string>",
"clientLocation": "<string>",
"currency": "<string>",
"hourlyRate": "<string>",
"requirements": [
{}
],
"settings": {},
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total": "<string>",
"outcome": "<string>",
"outcomeAt": "2023-11-07T05:31:56Z",
"outcomeReason": "<string>",
"outcomeNotes": "<string>",
"outcomeValue": "<string>",
"authorName": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Schema for creating a proposal.
Pass templateId to pre-fill settings from a saved ProposalTemplate.
Explicit fields in settings override template defaults.
Response
Successful Response
Schema for proposal response.
⌘I