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

Change envelope user account owner

POST

https://api.signater.com/v1/ecm/envelopes/{envelopeId}/user-account-owner

Envelope

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

Changes the ownership of the existing envelope using its unique identifier to a different user. This operation transfers all associated permissions and responsibilities from the current owner to the new one. Be aware that the new owner must have the appropriate permissions to take ownership of the envelope.

Request

Authorization

Add parameter in header

x-api-token

Example:

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

Path Params

envelopeId

string <uuid>

required

Envelope ID

Body Params application/json

ownerId

string <uuid>

required

Id of the user to be set as the owner of the envelope

>= 1 characters

Example

{
  "ownerId": "6fca133e-df27-4184-865b-ae968dd1153e"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.signater.com/v1/ecm/envelopes//user-account-owner' \
--header 'Content-Type: application/json' \
--header 'x-api-token;' \
--data-raw '{
    "ownerId": "6fca133e-df27-4184-865b-ae968dd1153e"
}'

Responses

🟢204No Content

Envelope user account owner changed successfully

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

List available envelope owners

Rename envelope