Dart

DocuSign Send a Draft Envelope

See more DocuSign Examples

Demonstrates how to send a DocuSign draft envelope. Dart

import 'package:chilkat/chilkat.dart';

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

  final http = CkHttp();

  // Load a previously obtained OAuth2 access token.
  final jsonToken = CkJsonObject();
  try {
    jsonToken.loadFile('qa_data/tokens/docusign.json');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
  http.authToken = jsonToken.stringOf('access_token');

  // Send the following request.
  // Make sure to use your own account ID (obtained from Get Docusign User Account Information)

  // PUT https://demo.docusign.net/restapi/v2.1/accounts/<account ID>/envelopes/<envelope ID> HTTP/1.1
  // Accept: application/json
  // Cache-Control: no-cache
  // Authorization: Bearer eyJ0eX...
  // Content-Length: ...
  // Content-Type: application/json
  // 
  // {
  //   "status": "sent"
  // }

  final json = CkJsonObject();
  json.updateString('status', 'sent');

  final sbJson = CkStringBuilder();
  json.emitCompact = false;
  json.emitSb(sbJson);

  http.setRequestHeader('Cache-Control', 'no-cache');
  http.setRequestHeader('Accept', 'application/json');

  // Use your own account ID here.
  http.setUrlVar('accountId', '7f3f65ed-5e87-418d-94c1-92499ddc8252');
  // Use the envelope ID returned by DocuSign when creating the draft envelope).
  http.setUrlVar('envelopeId', 'cee4191c-f94e-4089-9d7c-8033685cbc1a');

  final url = 'https://demo.docusign.net/restapi/v2.1/accounts/{\$accountId}/envelopes/{\$envelopeId}';

  final resp = CkHttpResponse();
  try {
    http.httpSb('PUT', url, sbJson, 'utf-8', 'application/json', resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final jResp = CkJsonObject();
  jResp.load(resp.bodyStr);
  jResp.emitCompact = false;

  print('Response Body:');
  print(jResp.emit());

  // If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
  final respStatusCode = resp.statusCode;
  print('Response Status Code = $respStatusCode');
  if (respStatusCode >= 400) {
    print('Response Header:');
    print(resp.header);
    print('Failed.');
    return;
  }

  // Sample JSON response:
  // (Sample code for parsing the JSON response is shown below)

  // If the envelope you're trying to send is not yet completed, you'll get an error such as this:
  // {
  //   "errorCode": "ENVELOPE_IS_INCOMPLETE",
  //   "message": "The Envelope is not Complete. A Complete Envelope Requires Documents, Recipients, Tabs, and a Subject Line."
  // }

  // Sample code for parsing the JSON response...
  // Use the following online tool to generate parsing code from sample JSON:
  // Generate Parsing Code from JSON
}