Chilkat Online Tools

phpAx / DocuSign REST API / Returns a URL to the edit view UI.

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

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

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

// {
//   "returnUrl": "sample string 1"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('returnUrl','sample string 1');

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

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/edit','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

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

Postman Collection Item JSON

{
  "name": "Returns a URL to the edit view UI.",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"returnUrl\": \"sample string 1\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/edit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "views",
        "edit"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    },
    "description": "Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. \n\nUpon sending completion, the user is returned to the return URL provided by the API application.\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": [
  ]
}