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

Update vault

PATCH

https://api.signater.com/v1/ecm/vaults/{vaultId}

Vault

Last modified:2025-03-29 12:47:42

Updates the properties of an existing vault. Note that the access type of a vault cannot be changed once it is created. However, for vaults with 'member' access type, you can add or remove members, modifying who has access to the vault.

Request

Authorization

Add parameter in header

x-api-token

Example:

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

Path Params

vaultId

string <uuid>

required

Vault ID

Body Params application/json

name

string

required

Name of the vault

>= 2 characters<= 200 characters

description

string | null

optional

Description of the vault

<= 400 characters

memberIds

array[string <uuid>] | null

optional

User member IDs of the vault (required for UserAccountGroup type, you also must explicitly add yourself if you want to be a member)

Example

{
  "name": "New Vault name",
  "description": "New Vault Description",
  "memberIds": [
    "958305a8-99e8-4db8-a691-3eab8522bc6d",
    "ffb0e41c-ed0d-4d49-b982-3b643f928a8e"
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.signater.com/v1/ecm/vaults/' \
--header 'Content-Type: application/json' \
--header 'x-api-token;' \
--data-raw '{
    "name": "New Vault name",
    "description": "New Vault Description",
    "memberIds": [
        "958305a8-99e8-4db8-a691-3eab8522bc6d",
        "ffb0e41c-ed0d-4d49-b982-3b643f928a8e"
    ]
}'

Responses

🟢204No Content

Vault updated successfully

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Create vault

Get vault