Skip to content

[SIGN-15354] Remove TemplateUpdate endpoint #541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adanilowski-dropbox merged 1 commit into from
May 8, 2026
Merged

[SIGN-15354] Remove TemplateUpdate endpoint #541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion openapi-raw.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7286,7 +7286,9 @@ paths:
seo:
title: '_t__TemplateUpdate::SEO::TITLE'
description: '_t__TemplateUpdate::SEO::DESCRIPTION'
x-hideOn: doc
x-hideOn:
- doc
- sdk
'/template/update_files/{template_id}':
post:
tags:
Expand Down Expand Up @@ -10430,6 +10432,9 @@ components:
- sdk
- doc
type: object
x-hideOn:
- sdk
- doc
TemplateUpdateFilesRequest:
properties:
client_id:
Expand Down Expand Up @@ -13387,6 +13392,9 @@ components:
summary: 'Default Example'
value:
$ref: examples/json/TemplateUpdateRequest.json
x-hideOn:
- sdk
- doc
TemplateUpdateFilesRequest:
summary: 'Default Example'
value:
Expand Down
142 changes: 0 additions & 142 deletions openapi-sdk.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7250,120 +7250,6 @@ paths:
seo:
title: 'Remove User from Template | REST API | Dropbox Sign for Developers'
description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.'
'/template/update/{template_id}':
post:
tags:
- Template
summary: 'Update Template'
description: 'Update template fields. Every field is optional and the endpoint will only change whatever is provided. The fields not included in the request payload will remain unchanged.'
operationId: templateUpdate
parameters:
-
name: template_id
in: path
description: 'The ID of the template to update.'
required: true
schema:
type: string
example: f57db65d3f933b5316d398057a36176831451a35
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateUpdateRequest'
examples:
example:
$ref: '#/components/examples/TemplateUpdateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/TemplateUpdateRequest'
responses:
'200':
description: 'successful operation'
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateGetResponse'
examples:
example:
$ref: '#/components/examples/TemplateGetResponse'
'4XX':
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400Response'
401_example:
$ref: '#/components/examples/Error401Response'
402_example:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
429_example:
$ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
-
api_key: []
-
oauth2:
- template_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
$ref: examples/TemplateUpdateExample.php
-
lang: 'C#'
label: 'C#'
source:
$ref: examples/TemplateUpdateExample.cs
-
lang: TypeScript
label: TypeScript
source:
$ref: examples/TemplateUpdateExample.ts
-
lang: Java
label: Java
source:
$ref: examples/TemplateUpdateExample.java
-
lang: Ruby
label: Ruby
source:
$ref: examples/TemplateUpdateExample.rb
-
lang: Python
label: Python
source:
$ref: examples/TemplateUpdateExample.py
-
lang: cURL
label: cURL
source:
$ref: examples/TemplateUpdateExample.sh
x-meta:
seo:
title: 'Update Template | REST API | Dropbox Sign for Developers'
description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to update properties of an existing template, click here.'
'/template/update_files/{template_id}':
post:
tags:
Expand Down Expand Up @@ -10933,30 +10819,6 @@ components:
type: string
format: email
type: object
TemplateUpdateRequest:
properties:
cc_roles:
description: 'The CC roles that must be assigned when using the template to send a signature request.'
type: array
items:
type: string
title:
description: 'The title you want to assign to the SignatureRequest.'
type: string
subject:
description: 'The new default template email subject.'
type: string
maxLength: 200
message:
description: 'The new default template email message.'
type: string
maxLength: 5000
form_fields:
description: 'A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field.'
type: array
items:
$ref: '#/components/schemas/SubUpdateFormField'
type: object
TemplateUpdateFilesRequest:
properties:
client_id:
Expand Down Expand Up @@ -14154,10 +14016,6 @@ components:
summary: 'Default Example'
value:
$ref: examples/json/TemplateRemoveUserRequest.json
TemplateUpdateRequest:
summary: 'Default Example'
value:
$ref: examples/json/TemplateUpdateRequest.json
TemplateUpdateFilesRequest:
summary: 'Default Example'
value:
Expand Down
28 changes: 0 additions & 28 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10799,30 +10799,6 @@ components:
type: string
format: email
type: object
TemplateUpdateRequest:
properties:
cc_roles:
description: 'The CC roles that must be assigned when using the template to send a signature request.'
type: array
items:
type: string
title:
description: 'The title you want to assign to the SignatureRequest.'
type: string
subject:
description: 'The new default template email subject.'
type: string
maxLength: 200
message:
description: 'The new default template email message.'
type: string
maxLength: 5000
form_fields:
description: 'A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field.'
type: array
items:
$ref: '#/components/schemas/SubUpdateFormField'
type: object
TemplateUpdateFilesRequest:
properties:
client_id:
Expand Down Expand Up @@ -14026,10 +14002,6 @@ components:
summary: 'Default Example'
value:
$ref: examples/json/TemplateRemoveUserRequest.json
TemplateUpdateRequest:
summary: 'Default Example'
value:
$ref: examples/json/TemplateUpdateRequest.json
TemplateUpdateFilesRequest:
summary: 'Default Example'
value:
Expand Down
2 changes: 0 additions & 2 deletions sdks/dotnet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,6 @@ Class | Method | HTTP request | Description
*TemplateApi* | [**TemplateGet**](docs/TemplateApi.md#templateget) | **GET** /template/{template_id} | Get Template
*TemplateApi* | [**TemplateList**](docs/TemplateApi.md#templatelist) | **GET** /template/list | List Templates
*TemplateApi* | [**TemplateRemoveUser**](docs/TemplateApi.md#templateremoveuser) | **POST** /template/remove_user/{template_id} | Remove User from Template
*TemplateApi* | [**TemplateUpdate**](docs/TemplateApi.md#templateupdate) | **POST** /template/update/{template_id} | Update Template
*TemplateApi* | [**TemplateUpdateFiles**](docs/TemplateApi.md#templateupdatefiles) | **POST** /template/update_files/{template_id} | Update Template Files
*UnclaimedDraftApi* | [**UnclaimedDraftCreate**](docs/UnclaimedDraftApi.md#unclaimeddraftcreate) | **POST** /unclaimed_draft/create | Create Unclaimed Draft
*UnclaimedDraftApi* | [**UnclaimedDraftCreateEmbedded**](docs/UnclaimedDraftApi.md#unclaimeddraftcreateembedded) | **POST** /unclaimed_draft/create_embedded | Create Embedded Unclaimed Draft
Expand Down Expand Up @@ -396,7 +395,6 @@ Class | Method | HTTP request | Description
- [Model.TemplateUpdateFilesRequest](docs/TemplateUpdateFilesRequest.md)
- [Model.TemplateUpdateFilesResponse](docs/TemplateUpdateFilesResponse.md)
- [Model.TemplateUpdateFilesResponseTemplate](docs/TemplateUpdateFilesResponseTemplate.md)
- [Model.TemplateUpdateRequest](docs/TemplateUpdateRequest.md)
- [Model.UnclaimedDraftCreateEmbeddedRequest](docs/UnclaimedDraftCreateEmbeddedRequest.md)
- [Model.UnclaimedDraftCreateEmbeddedWithTemplateRequest](docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md)
- [Model.UnclaimedDraftCreateRequest](docs/UnclaimedDraftCreateRequest.md)
Expand Down
126 changes: 0 additions & 126 deletions sdks/dotnet/docs/TemplateApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ All URIs are relative to *https://api.hellosign.com/v3*
| [**TemplateGet**](TemplateApi.md#templateget) | **GET** /template/{template_id} | Get Template |
| [**TemplateList**](TemplateApi.md#templatelist) | **GET** /template/list | List Templates |
| [**TemplateRemoveUser**](TemplateApi.md#templateremoveuser) | **POST** /template/remove_user/{template_id} | Remove User from Template |
| [**TemplateUpdate**](TemplateApi.md#templateupdate) | **POST** /template/update/{template_id} | Update Template |
| [**TemplateUpdateFiles**](TemplateApi.md#templateupdatefiles) | **POST** /template/update_files/{template_id} | Update Template Files |

<a id="templateadduser"></a>
Expand Down Expand Up @@ -1136,131 +1135,6 @@ catch (ApiException e)
- **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | successful operation | * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> |
| **4XX** | failed_operation | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

<a id="templateupdate"></a>
# **TemplateUpdate**
> TemplateGetResponse TemplateUpdate (string templateId, TemplateUpdateRequest templateUpdateRequest)

Update Template

Update template fields. Every field is optional and the endpoint will only change whatever is provided. The fields not included in the request payload will remain unchanged.

### Example
```csharp
using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;

namespace Dropbox.SignSandbox;

public class TemplateUpdateExample
{
public static void Run()
{
var config = new Configuration();
config.Username = "YOUR_API_KEY";
// config.AccessToken = "YOUR_ACCESS_TOKEN";

var formFields1 = new SubUpdateFormField(
apiId: "uniqueIdHere_1",
name: "New name 1"
);

var formFields2 = new SubUpdateFormField(
apiId: "uniqueIdHere_2",
name: "New name 2"
);

var formFields = new List<SubUpdateFormField>
{
formFields1,
formFields2,
};

var templateUpdateRequest = new TemplateUpdateRequest(
title: "Test Title",
subject: "Test Subject",
message: "Test Message",
ccRoles: [
"CC Role 1",
"CC Role 2",
],
formFields: formFields
);

try
{
var response = new TemplateApi(config).TemplateUpdate(
templateId: "f57db65d3f933b5316d398057a36176831451a35",
templateUpdateRequest: templateUpdateRequest
);

Console.WriteLine(response);
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling TemplateApi#TemplateUpdate: " + e.Message);
Console.WriteLine("Status Code: " + e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}

```

#### Using the TemplateUpdateWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.

```csharp
try
{
// Update Template
ApiResponse<TemplateGetResponse> response = apiInstance.TemplateUpdateWithHttpInfo(templateId, templateUpdateRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TemplateApi.TemplateUpdateWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```

### Parameters

| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **templateId** | **string** | The ID of the template to update. | |
| **templateUpdateRequest** | [**TemplateUpdateRequest**](TemplateUpdateRequest.md) | | |

### Return type

[**TemplateGetResponse**](TemplateGetResponse.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
Expand Down
Loading
Loading