Swagger\Client\ESignatureApi

All URIs are relative to /api/v1

Method	HTTP request	Description
leadsApplicationsAppIdMappingsGet	GET /leads/applications/{appId}/mappings	Get a list of available application field mappings
leadsApplicationsAppIdMappingsMapIdDelete	DELETE /leads/applications/{appId}/mappings/{mapId}	Delete an application field mapping
leadsApplicationsAppIdMappingsMapIdGet	GET /leads/applications/{appId}/mappings/{mapId}	Get an application field mapping list
leadsApplicationsAppIdMappingsMapIdPatch	PATCH /leads/applications/{appId}/mappings/{mapId}	Update an application field mapping
leadsApplicationsAppIdMappingsPost	POST /leads/applications/{appId}/mappings	Create a new application field mapping
leadsApplicationsGet	GET /leads/applications	Get a list of available applications
leadsLeadIdSignaturesApplicationIdGeneratePost	POST /leads/{leadId}/signatures/{applicationId}/generate	Generate an e-signature document
leadsLeadIdSignaturesApplicationIdSendPost	POST /leads/{leadId}/signatures/{applicationId}/send	Send an e-signature document
leadsLeadIdSignaturesGet	GET /leads/{leadId}/signatures	Get a list of all lead e-signatures documents
leadsSignaturesApplicationIdDownloadGet	GET /leads/signatures/{applicationId}/download	Download an e-signature document

leadsApplicationsAppIdMappingsGet

\Swagger\Client\Model\InlineResponse20033 leadsApplicationsAppIdMappingsGet($app_id, $page, $per_page)

Get a list of available application field mappings

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 56; // int | Application Id
$page = 56; // int | Page number
$per_page = 56; // int | Count of records per page

try {
    $result = $apiInstance->leadsApplicationsAppIdMappingsGet($app_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsApplicationsAppIdMappingsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	int	Application Id
page	int	Page number	[optional]
per_page	int	Count of records per page	[optional]

Return type

\Swagger\Client\Model\InlineResponse20033

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

leadsApplicationsAppIdMappingsMapIdDelete

\Swagger\Client\Model\InlineResponse20034 leadsApplicationsAppIdMappingsMapIdDelete($app_id, $map_id)

Delete an application field mapping

Deletion of application field mapping

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 56; // int | Application Id
$map_id = 56; // int | Mapping Id

try {
    $result = $apiInstance->leadsApplicationsAppIdMappingsMapIdDelete($app_id, $map_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsApplicationsAppIdMappingsMapIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	int	Application Id
map_id	int	Mapping Id

Return type

\Swagger\Client\Model\InlineResponse20034

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

leadsApplicationsAppIdMappingsMapIdGet

\Swagger\Client\Model\ApplicationField leadsApplicationsAppIdMappingsMapIdGet($app_id, $map_id)

Get an application field mapping list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 56; // int | Application Id
$map_id = 56; // int | Mapping Id

try {
    $result = $apiInstance->leadsApplicationsAppIdMappingsMapIdGet($app_id, $map_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsApplicationsAppIdMappingsMapIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	int	Application Id
map_id	int	Mapping Id

Return type

\Swagger\Client\Model\ApplicationField

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

leadsApplicationsAppIdMappingsMapIdPatch

\Swagger\Client\Model\ApplicationField leadsApplicationsAppIdMappingsMapIdPatch($app_id, $map_id, $body)

Update an application field mapping

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 56; // int | Application Id
$map_id = 56; // int | Mapping Id
$body = new \Swagger\Client\Model\ApplicationField(); // \Swagger\Client\Model\ApplicationField | 

try {
    $result = $apiInstance->leadsApplicationsAppIdMappingsMapIdPatch($app_id, $map_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsApplicationsAppIdMappingsMapIdPatch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	int	Application Id
map_id	int	Mapping Id
body	\Swagger\Client\Model\ApplicationField		[optional]

Return type

\Swagger\Client\Model\ApplicationField

Authorization

Token

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

leadsApplicationsAppIdMappingsPost

\Swagger\Client\Model\ApplicationField leadsApplicationsAppIdMappingsPost($app_id, $body)

Create a new application field mapping

Creation of new application field mapping

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 56; // int | Application Id
$body = new \Swagger\Client\Model\ApplicationField(); // \Swagger\Client\Model\ApplicationField | 

try {
    $result = $apiInstance->leadsApplicationsAppIdMappingsPost($app_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsApplicationsAppIdMappingsPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	int	Application Id
body	\Swagger\Client\Model\ApplicationField		[optional]

Return type

\Swagger\Client\Model\ApplicationField

Authorization

Token

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

leadsApplicationsGet

\Swagger\Client\Model\BriefApplicationInfo[] leadsApplicationsGet()

Get a list of available applications

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->leadsApplicationsGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsApplicationsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\BriefApplicationInfo[]

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

leadsLeadIdSignaturesApplicationIdGeneratePost

\Swagger\Client\Model\InlineResponse20020 leadsLeadIdSignaturesApplicationIdGeneratePost($lead_id, $application_id, $body)

Generate an e-signature document

Generate a new electronic signature document and receive a signature-ready application URL.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$lead_id = 56; // int | Lead Id
$application_id = 56; // int | Application Id
$body = new \Swagger\Client\Model\Body8(); // \Swagger\Client\Model\Body8 | 

try {
    $result = $apiInstance->leadsLeadIdSignaturesApplicationIdGeneratePost($lead_id, $application_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsLeadIdSignaturesApplicationIdGeneratePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	int	Lead Id
application_id	int	Application Id
body	\Swagger\Client\Model\Body8		[optional]

Return type

\Swagger\Client\Model\InlineResponse20020

Authorization

Token

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

leadsLeadIdSignaturesApplicationIdSendPost

\Swagger\Client\Model\InlineResponse20021 leadsLeadIdSignaturesApplicationIdSendPost($lead_id, $application_id, $body)

Send an e-signature document

Send an e-signature document using an email template for signature.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$lead_id = 56; // int | Lead Id
$application_id = 56; // int | Application Id
$body = new \Swagger\Client\Model\Body9(); // \Swagger\Client\Model\Body9 | 

try {
    $result = $apiInstance->leadsLeadIdSignaturesApplicationIdSendPost($lead_id, $application_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsLeadIdSignaturesApplicationIdSendPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	int	Lead Id
application_id	int	Application Id
body	\Swagger\Client\Model\Body9		[optional]

Return type

\Swagger\Client\Model\InlineResponse20021

Authorization

Token

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

leadsLeadIdSignaturesGet

\Swagger\Client\Model\InlineResponse20022 leadsLeadIdSignaturesGet($lead_id, $page, $per_page)

Get a list of all lead e-signatures documents

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$lead_id = 56; // int | Lead Id
$page = 56; // int | Page number
$per_page = 56; // int | Count of records per page

try {
    $result = $apiInstance->leadsLeadIdSignaturesGet($lead_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsLeadIdSignaturesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
lead_id	int	Lead Id
page	int	Page number	[optional]
per_page	int	Count of records per page	[optional]

Return type

\Swagger\Client\Model\InlineResponse20022

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

leadsSignaturesApplicationIdDownloadGet

string leadsSignaturesApplicationIdDownloadGet($application_id)

Download an e-signature document

Download an e-signature document.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new Swagger\Client\Api\ESignatureApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$application_id = 56; // int | Application Id

try {
    $result = $apiInstance->leadsSignaturesApplicationIdDownloadGet($application_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ESignatureApi->leadsSignaturesApplicationIdDownloadGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
application_id	int	Application Id

Return type

string

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ESignatureApi.md

Latest commit

History

ESignatureApi.md

File metadata and controls

Swagger\Client\ESignatureApi

leadsApplicationsAppIdMappingsGet

Example

Parameters

Return type

Authorization

HTTP request headers

leadsApplicationsAppIdMappingsMapIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

leadsApplicationsAppIdMappingsMapIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

leadsApplicationsAppIdMappingsMapIdPatch

Example

Parameters

Return type

Authorization

HTTP request headers

leadsApplicationsAppIdMappingsPost

Example

Parameters

Return type

Authorization

HTTP request headers

leadsApplicationsGet

Example

Parameters

Return type

Authorization

HTTP request headers

leadsLeadIdSignaturesApplicationIdGeneratePost

Example

Parameters

Return type

Authorization

HTTP request headers

leadsLeadIdSignaturesApplicationIdSendPost

Example

Parameters

Return type

Authorization

HTTP request headers

leadsLeadIdSignaturesGet

Example

Parameters

Return type

Authorization

HTTP request headers

leadsSignaturesApplicationIdDownloadGet

Example

Parameters

Return type

Authorization

HTTP request headers