Chilkat Online Tools

phpExt / DocuSign eSignature REST API / Returns a URL to the envelope correction UI.

Back to Collection Items

<?php

include("chilkat.php");

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "suppressNavigation": "sample string 1",
//   "returnUrl": "sample string 2"
// }

$json = new CkJsonObject();
$json->UpdateString('suppressNavigation','sample string 1');
$json->UpdateString('returnUrl','sample string 2');

// Adds the "Authorization: Bearer {{accessToken}}" header.
$http->put_AuthToken('{{accessToken}}');
$http->SetRequestHeader('Accept','application/json');

$resp = new CkHttpResponse();
$success = $http->HttpJson('POST','https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/correct',$json,'application/json',$resp);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";

?>

Curl Command

curl -X POST
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "suppressNavigation": "sample string 1",
  "returnUrl": "sample string 2"
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/correct

Postman Collection Item JSON

{
  "name": "Returns a URL to the envelope correction UI.",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"suppressNavigation\": \"sample string 1\",\n  \"returnUrl\": \"sample string 2\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/correct",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "views",
        "correct"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}",
          "type": "string"
        }
      ]
    },
    "description": "Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications.\n\nImportant: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. "
  },
  "response": [
  ]
}