DOCUMENTS

Get Envelope Types

Retrieve the custom envelope types available to your account. Pass the selected ID as envelope_type_id when adding a document. Contact support to configure a custom envelope type.

Class: documents

Method: get-envelope-types

POST/documents/get-envelope-types

Parameters

  • client_id*
  • akey*

JSON response

JSONResponse example
{
  "envelope_types": [
    {
      "envelope_type_id": "1",
      "envelope_alias": "Standard Business Envelope"
    },
    {
      "envelope_type_id": "2",
      "envelope_alias": "Large Document Envelope"
    }
  ]
}

XML response

XMLResponse example
<?xml version="1.0" encoding="UTF-8"?>
<wmc-response status="1">
<envelope_types>
	<envelope_type envelope_type_id='1'>
		<envelope_type_id>1</envelope_type_id>
		<envelope_alias>Standard Business Envelope</envelope_alias>
	</envelope_type>
	<envelope_type envelope_type_id='2'>
		<envelope_type_id>2</envelope_type_id>
		<envelope_alias>Large Document Envelope</envelope_alias>
	</envelope_type>
</envelope_types>
</wmc-response>

Search documentation