Skip to main content
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
}
'
{
  "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>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.getquikly.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

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.

​
name
string
required
​
templateId
string<uuid> | null
​
clientName
string | null
​
clientLocation
string | null
​
currency
string
default:USD
​
hourlyRate
default:50.00
​
requirements
Requirement · object[]
​
settings
Settings · object
​
total

Response

Successful Response

Schema for proposal response.

​
id
string<uuid>
required
​
userId
string<uuid>
required
​
name
string
required
​
clientName
string | null
required
​
clientLocation
string | null
required
​
currency
string
required
​
hourlyRate
string
required
​
requirements
Requirements · object[]
required
​
settings
Settings · object
required
​
status
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
teamId
string<uuid> | null
​
total
string | null
​
outcome
string | null
​
outcomeAt
string<date-time> | null
​
outcomeReason
string | null
​
outcomeNotes
string | null
​
outcomeValue
string | null
​
authorName
string | null