Dropbox\Sign\TemplateApi

All URIs are relative to https://api.hellosign.com/v3.

Method	HTTP request	Description
templateAddUser()	POST /template/add_user/{template_id}	Add User to Template
templateCreate()	POST /template/create	Create Template
templateCreateEmbeddedDraft()	POST /template/create_embedded_draft	Create Embedded Template Draft
templateDelete()	POST /template/delete/{template_id}	Delete Template
templateFiles()	GET /template/files/{template_id}	Get Template Files
templateFilesAsDataUri()	GET /template/files_as_data_uri/{template_id}	Get Template Files as Data Uri
templateFilesAsFileUrl()	GET /template/files_as_file_url/{template_id}	Get Template Files as File Url
templateGet()	GET /template/{template_id}	Get Template
templateList()	GET /template/list	List Templates
templateRemoveUser()	POST /template/remove_user/{template_id}	Remove User from Template
templateUpdateFiles()	POST /template/update_files/{template_id}	Update Template Files

`templateAddUser()`

templateAddUser($template_id, $template_add_user_request): \Dropbox\Sign\Model\TemplateGetResponse

Add User to Template

Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$template_add_user_request = (new Dropbox\Sign\Model\TemplateAddUserRequest())
    ->setEmailAddress("george@dropboxsign.com");

try {
    $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateAddUser(
        template_id: "f57db65d3f933b5316d398057a36176831451a35",
        template_add_user_request: $template_add_user_request,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling TemplateApi#templateAddUser: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
template_id	string	The id of the Template to give the Account access to.
template_add_user_request	\Dropbox\Sign\Model\TemplateAddUserRequest

Return type

\Dropbox\Sign\Model\TemplateGetResponse

Authorization

api_key, oauth2

HTTP request headers

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

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

`templateCreate()`

templateCreate($template_create_request): \Dropbox\Sign\Model\TemplateCreateResponse

Create Template

Creates a template that can then be used.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$field_options = (new Dropbox\Sign\Model\SubFieldOptions())
    ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY);

$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole())
    ->setName("Client")
    ->setOrder(0);

$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole())
    ->setName("Witness")
    ->setOrder(1);

$signer_roles = [
    $signer_roles_1,
    $signer_roles_2,
];

$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText())
    ->setDocumentIndex(0)
    ->setApiId("uniqueIdHere_1")
    ->setType("text")
    ->setRequired(true)
    ->setSigner("1")
    ->setWidth(100)
    ->setHeight(16)
    ->setX(112)
    ->setY(328)
    ->setName("")
    ->setPage(1)
    ->setPlaceholder("")
    ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY);

$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature())
    ->setDocumentIndex(0)
    ->setApiId("uniqueIdHere_2")
    ->setType("signature")
    ->setRequired(true)
    ->setSigner("0")
    ->setWidth(120)
    ->setHeight(30)
    ->setX(530)
    ->setY(415)
    ->setName("")
    ->setPage(1);

$form_fields_per_document = [
    $form_fields_per_document_1,
    $form_fields_per_document_2,
];

$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField())
    ->setName("Full Name")
    ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT);

$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField())
    ->setName("Is Registered?")
    ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX);

$merge_fields = [
    $merge_fields_1,
    $merge_fields_2,
];

$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest())
    ->setClientId("37dee8d8440c66d54cfa05d92c160882")
    ->setMessage("For your approval")
    ->setSubject("Please sign this document")
    ->setTestMode(true)
    ->setTitle("Test Template")
    ->setCcRoles([
        "Manager",
    ])
    ->setFiles([
    ])
    ->setFieldOptions($field_options)
    ->setSignerRoles($signer_roles)
    ->setFormFieldsPerDocument($form_fields_per_document)
    ->setMergeFields($merge_fields);

try {
    $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate(
        template_create_request: $template_create_request,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
template_create_request	\Dropbox\Sign\Model\TemplateCreateRequest

Return type

\Dropbox\Sign\Model\TemplateCreateResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json, multipart/form-data
Accept: application/json

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

`templateCreateEmbeddedDraft()`

templateCreateEmbeddedDraft($template_create_embedded_draft_request): \Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse

Create Embedded Template Draft

The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$field_options = (new Dropbox\Sign\Model\SubFieldOptions())
    ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY);

$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField())
    ->setName("Full Name")
    ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT);

$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField())
    ->setName("Is Registered?")
    ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX);

$merge_fields = [
    $merge_fields_1,
    $merge_fields_2,
];

$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole())
    ->setName("Client")
    ->setOrder(0);

$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole())
    ->setName("Witness")
    ->setOrder(1);

$signer_roles = [
    $signer_roles_1,
    $signer_roles_2,
];

$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest())
    ->setClientId("37dee8d8440c66d54cfa05d92c160882")
    ->setMessage("For your approval")
    ->setSubject("Please sign this document")
    ->setTestMode(true)
    ->setTitle("Test Template")
    ->setCcRoles([
        "Manager",
    ])
    ->setFiles([
    ])
    ->setFieldOptions($field_options)
    ->setMergeFields($merge_fields)
    ->setSignerRoles($signer_roles);

try {
    $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft(
        template_create_embedded_draft_request: $template_create_embedded_draft_request,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
template_create_embedded_draft_request	\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest

Return type

\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json, multipart/form-data
Accept: application/json

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

`templateDelete()`

templateDelete($template_id)

Delete Template

Completely deletes the template specified from the account.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

try {
    (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateDelete(
        template_id: "f57db65d3f933b5316d398057a36176831451a35",
    );
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling TemplateApi#templateDelete: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
template_id	string	The id of the Template to delete.

Return type

void (empty response body)

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`templateFiles()`

templateFiles($template_id, $file_type): \SplFileObject

Get Template Files

Obtain a copy of the current documents specified by the template_id parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of 409 will be returned instead. In this case please wait for the template_created callback event.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

try {
    $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFiles(
        template_id: "f57db65d3f933b5316d398057a36176831451a35",
    );

    copy($response->getRealPath(), __DIR__ . '/file_response');
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling TemplateApi#templateFiles: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
template_id	string	The id of the template files to retrieve.
file_type	string	Set to `pdf` for a single merged document or `zip` for a collection of individual documents.	[optional]

Return type

\SplFileObject

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/pdf, application/zip, application/json

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

`templateFilesAsDataUri()`

templateFilesAsDataUri($template_id): \Dropbox\Sign\Model\FileResponseDataUri

Get Template Files as Data Uri

Obtain a copy of the current documents specified by the template_id parameter. Returns a JSON object with a data_uri representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of 409 will be returned instead. In this case please wait for the template_created callback event.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

try {
    $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFilesAsDataUri(
        template_id: "f57db65d3f933b5316d398057a36176831451a35",
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling TemplateApi#templateFilesAsDataUri: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
template_id	string	The id of the template files to retrieve.

Return type

\Dropbox\Sign\Model\FileResponseDataUri

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`templateFilesAsFileUrl()`

templateFilesAsFileUrl($template_id, $force_download): \Dropbox\Sign\Model\FileResponse

Get Template Files as File Url

Obtain a copy of the current documents specified by the template_id parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of 409 will be returned instead. In this case please wait for the template_created callback event.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

try {
    $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFilesAsFileUrl(
        template_id: "f57db65d3f933b5316d398057a36176831451a35",
        force_download: 1,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling TemplateApi#templateFilesAsFileUrl: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
template_id	string	The id of the template files to retrieve.
force_download	int	By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.	[optional] [default to 1]

Return type

\Dropbox\Sign\Model\FileResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`templateGet()`

templateGet($template_id): \Dropbox\Sign\Model\TemplateGetResponse

Get Template

Returns the Template specified by the template_id parameter.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

try {
    $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateGet(
        template_id: "f57db65d3f933b5316d398057a36176831451a35",
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling TemplateApi#templateGet: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
template_id	string	The id of the Template to retrieve.

Return type

\Dropbox\Sign\Model\TemplateGetResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`templateList()`

templateList($account_id, $page, $page_size, $query): \Dropbox\Sign\Model\TemplateListResponse

List Templates

Returns a list of the Templates that are accessible by you. Take a look at our search guide to learn more about querying templates.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

try {
    $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateList(
        page: 1,
        page_size: 20,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling TemplateApi#templateList: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
account_id	string	Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.	[optional]
page	int	Which page number of the Template List to return. Defaults to `1`.	[optional] [default to 1]
page_size	int	Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.	[optional] [default to 20]
query	string	String that includes search terms and/or fields to be used to filter the Template objects.	[optional]

Return type

\Dropbox\Sign\Model\TemplateListResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`templateRemoveUser()`

templateRemoveUser($template_id, $template_remove_user_request): \Dropbox\Sign\Model\TemplateGetResponse

Remove User from Template

Removes the specified Account's access to the specified Template.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$template_remove_user_request = (new Dropbox\Sign\Model\TemplateRemoveUserRequest())
    ->setEmailAddress("george@dropboxsign.com");

try {
    $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateRemoveUser(
        template_id: "f57db65d3f933b5316d398057a36176831451a35",
        template_remove_user_request: $template_remove_user_request,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling TemplateApi#templateRemoveUser: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
template_id	string	The id of the Template to remove the Account's access to.
template_remove_user_request	\Dropbox\Sign\Model\TemplateRemoveUserRequest

Return type

\Dropbox\Sign\Model\TemplateGetResponse

Authorization

api_key, oauth2

HTTP request headers

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

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

`templateUpdateFiles()`

templateUpdateFiles($template_id, $template_update_files_request): \Dropbox\Sign\Model\TemplateUpdateFilesResponse

Update Template Files

Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A template_created event will be sent when the files are updated or a template_error event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a template_error callback event.

Example

<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$template_update_files_request = (new Dropbox\Sign\Model\TemplateUpdateFilesRequest())
    ->setFiles([
    ]);

try {
    $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateUpdateFiles(
        template_id: "f57db65d3f933b5316d398057a36176831451a35",
        template_update_files_request: $template_update_files_request,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling TemplateApi#templateUpdateFiles: {$e->getMessage()}";
}

Parameters

Name	Type	Description	Notes
template_id	string	The ID of the template whose files to update.
template_update_files_request	\Dropbox\Sign\Model\TemplateUpdateFilesRequest

Return type

\Dropbox\Sign\Model\TemplateUpdateFilesResponse

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json, multipart/form-data
Accept: application/json

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

FilesExpand file tree

TemplateApi.md

Latest commit

History

TemplateApi.md

File metadata and controls

Dropbox\Sign\TemplateApi

templateAddUser()

Example

Parameters

Return type

Authorization

HTTP request headers

templateCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

templateCreateEmbeddedDraft()

Example

Parameters

Return type

Authorization

HTTP request headers

templateDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

templateFiles()

Example

Parameters

Return type

Authorization

HTTP request headers

templateFilesAsDataUri()

Example

Parameters

Return type

Authorization

HTTP request headers

templateFilesAsFileUrl()

Example

Parameters

Return type

Authorization

HTTP request headers

templateGet()

Example

Parameters

Return type

Authorization

HTTP request headers

templateList()

Example

Parameters

Return type

Authorization

HTTP request headers

templateRemoveUser()

Example

Parameters

Return type

Authorization

HTTP request headers

templateUpdateFiles()

Example

Parameters

Return type

Authorization

HTTP request headers

`templateAddUser()`

`templateCreate()`

`templateCreateEmbeddedDraft()`

`templateDelete()`

`templateFiles()`

`templateFilesAsDataUri()`

`templateFilesAsFileUrl()`

`templateGet()`

`templateList()`

`templateRemoveUser()`

`templateUpdateFiles()`