Skip to main content

Update proposal


Use the updateProposal method via SOAP APIv6 to update the details of a proposal or quote.

Request parameters

Request parameters for the updateProposal method via SOAP APIv6
Parameters Type Required/Optional Description
proposalId String Required The unique merchant proposal ID generated by the 2Checkout system.
sessionId String Required Unique 2Checkout session ID code.
Name String Optional Proposal name.
UserId String Optional The unique user ID generated by the 2Checkout system.
BillTo Object Optional  The billing details associated with the proposal.
SellTo Object Optional Represents the entity using the service. Used for tax calculation.

Request sample


require ('PATH_TO_AUTH');

$proposalID = "0573e71d-38bb-4d61-88ca-b3c557517c68";

try {
    $result = $soapClient->getProposalById($sessionID, $proposalID);
    echo "Fetching Proposal ID: {$proposalID} </br>";
catch (SoapFault $e) {
    echo "Could not fetch proposal: " . $e->getMessage();

$result->Name = "Updated proposal name";
$result->UserId = "myuser";
$result->BillTo->FirstName = "Billing Contact first name";
$result->BillTo->LastName = "Billing Contact last name";
$result->BillTo->Email = "";
$result->BillTo->Country = "US";
$result->BillTo->State = "California";
$result->BillTo->vatCode = "85421564";
$result->BillTo->City = "San Francisco";
$result->BillTo->Address = "Street name No. 9 San Francisco, California";
$result->SellTo->FirstName = "Contact first name";
$result->SellTo->LastName = "Contact last name";
$result->SellTo->Email = "";
$result->SellTo->Country = "US";
$result->SellTo->State = "California";
$result->SellTo->vatCode = "85421564";
$result->SellTo->City = "San Francisco";
$result->SellTo->Address = "Street name No. 5 San Francisco, California";

try {
    $updateResult = $soapClient->updateProposal($sessionID, $result->ProposalId, $result);
    echo "New proposal created: </br>", 
catch (SoapFault $e) {
    echo "Could not create proposal: " . $e->getMessage();


The updateProposal call via SOAP APIv6 returns the Proposal object.


  • Was this article helpful?