Update a Project Signer
Update the details of a signer associated with a specific project in the ENTERPRISE API. This endpoint allows you to modify signer information such as name, signing order, and role within a project.
HTTP Method & URL
-
Method:
PUT -
URL:
{{host}}/projects/:uuid/signers/:signerId?user_type=ENTERPRISE_API
Authentication
-
Type: Bearer Token (recommended)
-
Header:
Authorization: Bearer {USER-TOKEN}
Path Parameters
| Name | Type | Description |
|---|---|---|
| uuid | string | The UUID of the project |
| signerId | string | The ID of the signer to update |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| user_type | string | Yes | Must be set to ENTERPRISE_API |
Request Body
Send a raw JSON object with the following fields:
| Field | Type | Required | Description |
|---|---|---|---|
| first_name | string | Yes | First name of the signer (e.g., "John") |
| last_name | string | Yes | Last name of the signer (e.g., "Doe") |
| sequence | integer | Yes | Signer order in the signing process (1-10) |
| signer_role | string | Yes | Role of the signer (Creator, Signer, Viewer, Approver, Issuee) |
Example Request Body:
{
"first_name": "John",
"last_name": "Doe",
"sequence": 1,
"signer_role": "Signer"
}
Example Request
PUT {{host}}/projects/{{project-uuid}}/signers/{{signerId}}?user_type=ENTERPRISE_API
Authorization: Bearer {USER-TOKEN}
Content-Type: application/json
{
"first_name": "John",
"last_name": "Doe",
"sequence": 1,
"signer_role": "Signer"
}
Example Successful Response
{
"id": "{{signerId}}",
"first_name": "John",
"last_name": "Doe",
"sequence": 1,
"signer_role": "Signer",
"status": "updated"
}
Error Responses
| Status Code | Description | Example Body |
|---|---|---|
| 400 | Project not found | { "error": "Project not found" } |
| 404 | Signer not found | { "error": "Signer not found" } |
| 401 | Unauthorized | { "error": "Unauthorized" } |
| 422 | Validation error | { "error": "Invalid input data" } |
Usage Notes
-
Ensure the
user_typequery parameter is always set toENTERPRISE_API. -
The
sequencefield determines the order in which signers are required to sign (must be unique per project and between 1-10). -
Only users with appropriate permissions can update signer details.
-
All fields in the request body are required.
-
Use environment variables (e.g.,
{{host}},{{project-uuid}},{{signerId}}) for flexibility across environments.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
