unapprove()

Unapproves one or more transactions that were previously approved.

Syntax

            UnapproveResult[] unapproveResults = stub.unapprove(new UnapproveRequest[] unapproveRequests); 

          

Usage

Use the unapprove() command to unapprove transactions which were previously approved. The maximum number of objects you can unapprove with one single call is 1,000.

Transactions that were approved and subsequently billed or archived cannot be unapproved.

For information about object types for which the XML API and SOAP API support approval-related operations, see Approval-Related Operations.

Arguments

Name	Type	Description
unapproveRequests	UnapproveRequest[]	Array of UnapproveRequest objects

Response

UnapproveResult[] — Array of UnapproveResult objects.

Sample Code — C#

            // unapprove an envelope which has already been approved
oaEnvelope env = new oaEnvelope();
env.id = "122";

oaApproval appr = new oaApproval();
appr.cc = "[e-mail]"; // cc approval email to additional contacts
appr.notes = "Approval notes";

UnapproveRequest ur = new UnapproveRequest();
ur.unapprove = env;
ur.approval = appr;

UnapproveResult[] results = _svc.unapprove(new UnapproveRequest[] { ur }); 

          

Sample Code — Java

            // Unapprove an envelope which has already been approved
oaEnvelope env = new oaEnvelope();
env.setId("122");
oaApproval appr = new oaApproval();
appr.setCc("[e-mail]"); // cc approval email to additional
contacts
appr.setNotes("approval notes");
UnapproveRequest ur = new UnapproveRequest();
ur.setApproval(appr);
ur.setUnapprove( env );

UnapproveResult[] results = stub.unapprove(new UnapproveRequest[] { ur });