Release On-Hold Signature Request

post/signature_request/release_hold/{signature_request_id}

Releases a held SignatureRequest that was claimed and prepared from an UnclaimedDraft. The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.

Securityapi_key or oauth2
Request
path Parameters
signature_request_id
required
string

The id of the SignatureRequest to release.

Example: fa5c8a0b0f492d768749333ad6fcc214c111e967
Responses
200

successful operation

4XX

failed_operation

Request samples
<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = HelloSignSDK\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$api = new HelloSignSDK\Api\SignatureRequestApi($config);

$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f";

try {
    $result = $api->signatureRequestReleaseHold($signatureRequestId);
    print_r($result);
} catch (HelloSignSDK\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling HelloSign API: "
        . print_r($error->getError());
}
Response samples
application/json
{
  • "signature_request": {
    }
}