proposals

Create a proposal

post/proposals

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/proposals
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Headers

X-Organization-Idstring required

UUID of the active organization. Sets org context for all scoped operations.

Request body

titlestring required
descriptionstring
priority'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL'
riskLevel'LOW' | 'MEDIUM' | 'HIGH'
estimatedBudgetnumber
estimatedDurationinteger

Weeks

departmentstring
strategicAlignmentstring
expectedBenefitsstring
businessJustificationstring
sponsorIdstring uuid
proposedProjectOwnerIdstring uuid

Response

Proposal created

idstring uuid required
titlestring required
descriptionstring nullable
stage'DRAFT' | 'SUBMITTED' | 'PROPOSAL_REVIEW' | 'BUSINESS_CASE' | 'BUSINESS_CASE_REVIEW' | 'PLANNING' | 'PLAN_REVIEW' | 'APPROVED' | 'ACTIVE' | 'ON_HOLD' | 'COMPLETED' | 'REJECTED' required
priority'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL' required
riskLevel'LOW' | 'MEDIUM' | 'HIGH' required
strategicAlignmentstring nullable
estimatedBudgetnumber nullable
estimatedDurationinteger nullable

Weeks

expectedBenefitsstring nullable
businessJustificationstring nullable
departmentstring nullable
sponsorIdstring uuid nullable
proposedProjectOwnerIdstring uuid nullable
projectIdstring uuid nullable

Set when the proposal has been linked or converted to a project.

organizationIdstring uuid required
createdAtstring date-time required
updatedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.