Update Project

put

https://{host}/api/v2/my/projects/{uuid}

Update Project

Update the details of an existing signature request project. This endpoint allows you to modify project metadata, document settings, email notifications, reminders, and access controls for a specific project identified by its UUID.

HTTP Method and URL

Method: PUT

URL:

      {{host}}/api/v2/my/projects/:uuid?user_type=ENTERPRISE_API

Authentication Requirements

Requires authentication via a valid user token (e.g., Bearer Token).
Ensure the user-token variable is set in your environment.

Path and Query Parameters

Path Parameters

Name	Type	Description
uuid	string	Unique identifier of the project to update. Use `{{project-uuid}}`.

Query Parameters

Name	Type	Required	Description
user_type	string	Yes	Must be set to `ENTERPRISE_API`.

Request Body

Send a JSON object with the fields you wish to update. Only include fields that need to be changed.

Body Parameters

Field	Type	Required	Description	Possible Values/Format
name	string	No	Name of the document/project.
file_name	string	No	Name of the file associated with the project.
description	string	No	Description of the document/project.
email_sender	string (email)	No	Email address of the sender.
email_subject	string	No	Subject line for notification emails.
email_message	string	No	Message body for notification emails.
signature_reminder_unit	string	No	Unit for reminders.	`day`
first_reminder_value	integer	No	Days until the first reminder is sent.
following_reminder_value	integer	No	Days between subsequent reminders.
first_reminder	string	No	Enable/disable first reminder.	`yes` or `no`
following_reminder	string	No	Enable/disable following reminders.	`yes` or `no`
schedule_date	string (date)	No	Date when the project will be scheduled to be sent.	Date format
signature_timestamp_label	string	No	Enable/disable signature timestamp label on documents.	`yes` or `no`
document_access	string	No	Access level for the document.	`Public` or `Private`
document_certification	string	No	Enable/disable document certification.	`yes` or `no`
authorized_download	string	No	Enable/disable authorized download of the document.	`yes` or `no`
signature_type	array	No	Array of allowed signature types for signatories.	`['Upload', 'Draw', 'Type']`
project_issuer	string	No	Enable/disable project issuer display.	`yes` or `no`
active_account_restriction	string	No	Enable/disable active account restriction for signatories.	`yes` or `no`
viewer_access	string	No	Access level for viewers.	`Public` or `Private`
completed_account_restriction	string	No	Enable/disable account restriction for completed documents.	`yes` or `no`
allow_resize	string	No	Enable/disable signature field resizing.	`yes` or `no`
attach_digital_certificate	string	No	Enable/disable attaching digital certificate to the document.	`yes` or `no`
document_access_key	string	No	Enable/disable document access key requirement.	`yes` or `no`
document_certification_on_email	string	No	Enable/disable sending document certification via email.	`yes` or `no`
document_key_on_all_pages	string	No	Enable/disable document key display on all pages.	`yes` or `no`
document_validation	string	No	Enable/disable document validation.	`yes` or `no`
sign_page_custom_branding	string	No	Enable/disable custom branding on signing page.	`yes` or `no`
custom_completion_page	string	No	Enable/disable custom completion page.	`yes` or `no`
custom_completion_page_color	string	No	Custom color for the completion page.	Hex color code (e.g., `#FFFFFF`)

Example Request Body

{
  "name": "Sample Project",
  "file_name": "sample.pdf",
  "description": "This is a sample document for signing.",
  "email_sender": "[email protected]",
  "email_subject": "Please sign the document",
  "email_message": "Kindly review and sign the attached document.",
  "signature_reminder_unit": "day",
  "first_reminder_value": 3,
  "following_reminder_value": 7,
  "first_reminder": "yes",
  "following_reminder": "no",
  "schedule_date": "2023-10-01",
  "signature_timestamp_label": "yes",
  "document_access": "Private",
  "document_certification": "yes",
  "authorized_download": "no",
  "signature_type": ["Upload", "Draw", "Type"],
  "project_issuer": "yes",
  "active_account_restriction": "no",
  "viewer_access": "Private",
  "completed_account_restriction": "no",
  "allow_resize": "yes",
  "attach_digital_certificate": "no"
}

Example Request

PUT {{host}}/api/v2/my/projects/{{project-uuid}}?user_type=ENTERPRISE_API
Content-Type: application/json
Authorization: Bearer {USER-TOKEN}
{
  "name": "Sample Project",
  "file_name": "sample.pdf",
  "description": "This is a sample document for signing.",
  "email_sender": "[email protected]",
  "email_subject": "Please sign the document",
  "email_message": "Kindly review and sign the attached document.",
  "signature_reminder_unit": "day",
  "first_reminder_value": 3,
  "following_reminder_value": 7,
  "first_reminder": "yes",
  "following_reminder": "no",
  "schedule_date": "2023-10-01",
  "signature_timestamp_label": "yes",
  "document_access": "Private",
  "document_certification": "yes",
  "authorized_download": "no",
  "signature_type": ["Upload", "Draw", "Type"],
  "project_issuer": "yes",
  "active_account_restriction": "no",
  "viewer_access": "Private",
  "completed_account_restriction": "no",
  "allow_resize": "yes",
  "attach_digital_certificate": "no"
}

Example Successful Response

{
  "status": "success",
  "message": "Project updated successfully.",
  "data": {
    "uuid": "{{project-uuid}}",
    "name": "Sample Project",
    "file_name": "sample.pdf",
    ...
  }
}

Error Responses

Status Code	Description	Example Response
400	Bad Request	`{ "status": "error", "message": "Invalid input." }`
401	Unauthorized	`{ "status": "error", "message": "Unauthorized." }`
403	Forbidden	`{ "status": "error", "message": "Forbidden." }`
404	Project Not Found	`{ "status": "error", "message": "Not Found." }`
500	Internal Server Error	`{ "status": "error", "message": "Server error." }`

Usage Notes

Only include fields in the request body that you want to update; omitted fields will remain unchanged.
Ensure the user_type query parameter is always set to ENTERPRISE_API.
Use valid UUIDs for the :uuid path parameter.
The endpoint requires authentication; ensure your token is valid and has the necessary permissions.
Refer to the UPDATE PROJECT request for saved examples and further details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

string

required

Query Params

user_type

string

Body Params

name

string

document name

file_name

string

file_name

description

string

This is a sample document for signing.

email_sender

string

email sender ([email protected])

email_subject

string

email_subject

email_message

string

message

signature_reminder_unit

string

day

first_reminder

string

yes | no

first_reminder_value

integer

following_reminder

string

yes | no

following_reminder_value

integer

schedule_date

string

date of schedule the project will be sent

signature_timestamp_label

string

yes | no

document_access

string

Public | Private

document_certification

string

yes | no

authorized_download

string

yes | no

signature_type

string

array of allowed signature type (eg: ['Upload', 'Draw', 'Type'])

project_issuer

string

yes | no

active_account_restriction

string

yes | no

viewer_access

string

Public | Private

completed_account_restriction

string

yes | no

allow_resize

string

yes | no

attach_digital_certificate

string

yes | no

document_access_key

string

yes | no

document_certification_on_email

string

yes | no

document_key_on_all_pages

string

yes | no

document_validation

string

yes | no

sign_page_custom_branding

string

yes | no

custom_completion_page

string

yes | no

custom_completion_page_color

string

FFFFFF

document_password

string

qr_code

string

yes | no

pages

integer

page no.

page_access

string

All | Selected

Responses

FFFFFF

200OK

404Not Found