Skip to main content
POST
Create Proposal

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