Proposal API Guide

Proposals are a supplier's response to a planner's RFP (Request for Proposal), proposing a price plan for a set of services that fit the RFP's requirements. This guide will help you understand how to manage proposals using the REST API, including creating, updating, and submitting proposals.

Proposals and Drafts#

A proposal can either be a draft or published. Drafts are only visible to you and can be edited. Published proposals are visible on related RFPs and cannot be changed. A draft and published proposal share the same ID.

You can't directly create a published proposal. You need to first create the proposal draft, then submit the draft.

Managing Drafts#

This section describes how to manage proposal drafts. Using the APIs, you can manipulate your proposal drafts.

  1. Create a proposal draft, including all the desired details. Created drafts go to the NOT_SENT status. Alternatively, retrieve existing proposal drafts.
  2. If a proposal needs revisions, update the draft. Alternatively, if a draft becomes unneeded, cancel the proposal draft. Cancelling moves the proposal draft to the CANCELLED status.

Submitting Drafts#

To publish your proposal draft, submit it. This action turns the draft proposal into a published proposal and moves it to the SUBMITTED status.

Managing Published Proposals#

Published proposals are visible on associated RFPs. A draft proposal and published proposal share the same ID. You can get published proposals using their ID.

You cannot update the details of a published proposal.

If a proposal becomes unneeded, cancel the proposal, moving it to the CANCELLED status.

FAQ#

Why Can't I Create a Published Proposal Directly?#

Think of the Proposal Draft like the draft of an email. You can make as many changes to the proposal draft as you like in privacy. Once you are ready you can then publish.

Publishing the draft is like sending an email. Once an published proposal is sent, you can no longer edit it.