Update A Project Signer

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

NameTypeDescription
uuidstringThe UUID of the project
signerIdstringThe ID of the signer to update

Query Parameters

NameTypeRequiredDescription
user_typestringYesMust be set to ENTERPRISE_API

Request Body

Send a raw JSON object with the following fields:

FieldTypeRequiredDescription
first_namestringYesFirst name of the signer (e.g., "John")
last_namestringYesLast name of the signer (e.g., "Doe")
sequenceintegerYesSigner order in the signing process (1-10)
signer_rolestringYesRole 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 CodeDescriptionExample Body
400Project not found{ "error": "Project not found" }
404Signer not found{ "error": "Signer not found" }
401Unauthorized{ "error": "Unauthorized" }
422Validation error{ "error": "Invalid input data" }

Usage Notes

  • Ensure the user_type query parameter is always set to ENTERPRISE_API.

  • The sequence field 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Query Params
string
Body Params
string

name

string

surname

string

Signer order (eg: 1 or 2 or 3, up to 10th order

string

role (eg: Creator, Signer, Viewer, Approver, Issuee)

string

The IP address of the API user to capture the location of the user to be logged in the project history.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json