This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Rename envelope

POST

https://api.signater.com/v1/ecm/envelopes/{envelopeId}/rename

Last modified:2025-08-24 00:13:59

Renames an existing envelope using its unique identifier. This operation allows the user to change the envelope's name for better organization or clarity. Be aware that renaming the envelope does not affect its contents or associated signers, and the envelope's unique ID remains unchanged. Ensure the provided envelope ID exists and is valid before performing this action.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Path Params

Body Params application/json

Example

{
    "name": "New envelope name"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.signater.com/v1/ecm/envelopes//rename' \
--header 'Content-Type: application/json' \
--header 'x-api-token;' \
--data-raw '{
    "name": "New envelope name"
}'

Responses

🟢204No Content

Envelope renamed successfully

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-08-24 00:13:59

Change envelope user account owner

Move envelope