PUT api/SigningRoomManager/SigningRooms/{signingRoomId}
Allows a SigningRoom admin to update a SigningRoom if they have access to it.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| signingRoomId |
The SigningRoom identifier. |
integer |
Required |
Body Parameters
The updateed SigningRoom data.
ESignSystems.SmartSAFE.Models.SigningRoomManager.SigningRoomModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SigningRoomId |
Gets or sets the SigningRoom identifier. |
integer |
None. |
| SigningRoomGuid |
Gets or sets the SigningRoom GUID. |
string |
None. |
| ClientId |
Gets or sets the SigningRoom's client identifier. |
integer |
None. |
| ClientName |
Gets or sets the client's name. |
string |
None. |
| SigningRoomName |
Gets or sets the SigningRoom's name. |
string |
Required Max length: 256 |
| Description |
Gets or sets the SigningRoom's description. |
string |
Max length: 500 |
| CreatedByUserId |
Gets or sets the SigningRoom creator identifier. |
integer |
None. |
| EnableSigningRoomInvitations |
Gets or sets the enable signing room invitations bool. |
boolean |
None. |
| StartDate |
Gets or sets a string representing the date and time that the SigningRoom starts. |
string |
Required Data type: DateTime |
| Expired |
Gets a value indicating whether the SigningRoom has expired. |
boolean |
None. |
| ExpirationDate |
Gets or sets a string representing the date and time that the SigningRoom expires. |
string |
Data type: Date |
| SigningDate |
Gets or sets a string representing the date and time that the SigningRoom signs. |
string |
Data type: Date |
| ServerTimeZone |
Gets or sets the time zone of the server. |
string |
None. |
| Status |
Gets or sets the SigningRoom status. |
string |
None. |
| Participants |
Gets or sets the list of participants associated to the SigningRoom. |
Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.ParticipantModel |
None. |
| Documents |
Gets or sets the list of documents associated to the SigningRoom. |
Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.DocumentModel |
None. |
| SigningRoomAdmins |
Gets or sets the list of SigningRoom admin associated to the SigningRoom. |
Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.SigningRoomAdminModel |
None. |
| SigningRoomActivityLogs |
Gets or sets the list of SigningRoom activity logs associated to the SigningRoom. |
Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.SigningRoomActivityLogModel |
None. |
| UpdatedBy |
Gets or sets the name of the user that updated the model. |
string |
None. |
| UpdatedDate |
Gets or sets the date an time that the model was updated. |
date |
None. |
Request Formats
application/json, text/json
{
"SigningRoomId": 1,
"SigningRoomGuid": "sample string 1",
"ClientId": 1,
"ClientName": "sample string 2",
"SigningRoomName": "sample string 3",
"Description": "sample string 4",
"CreatedByUserId": 5,
"EnableSigningRoomInvitations": true,
"Expired": false,
"ServerTimeZone": "sample string 10",
"Status": "sample string 11",
"Participants": [
{
"ParticipantId": 1,
"SigningRoomId": 1,
"SortOrder": 1,
"ParticipantRoleTypeId": 1,
"FirstName": "sample string 1",
"LastName": "sample string 2",
"FullName": "sample string 3",
"Initials": "sample string 4",
"InvitationEmail": "sample string 5",
"InvitationCode": "sample string 6",
"AccessCode": "sample string 7",
"SigningRoomUrl": "sample string 8",
"ESignConsentAccepted": true,
"Deleted": true,
"UpdatedBy": "sample string 11",
"UpdatedDate": "2026-01-01T17:32:40.3616251-05:00"
},
{
"ParticipantId": 1,
"SigningRoomId": 1,
"SortOrder": 1,
"ParticipantRoleTypeId": 1,
"FirstName": "sample string 1",
"LastName": "sample string 2",
"FullName": "sample string 3",
"Initials": "sample string 4",
"InvitationEmail": "sample string 5",
"InvitationCode": "sample string 6",
"AccessCode": "sample string 7",
"SigningRoomUrl": "sample string 8",
"ESignConsentAccepted": true,
"Deleted": true,
"UpdatedBy": "sample string 11",
"UpdatedDate": "2026-01-01T17:32:40.3616251-05:00"
}
],
"Documents": [
{
"DocumentId": 1,
"ClientId": 1,
"SigningRoomId": 1,
"DocumentTypeId": 1,
"DocumentType": "sample string 1",
"DocumentGuid": "sample string 2",
"DocumentName": "sample string 3",
"Description": "sample string 4",
"PageCount": 1,
"FileExtension": "sample string 5",
"MimeType": "sample string 6",
"IsPDF": true,
"UDF1": "sample string 8",
"UDF2": "sample string 9",
"UDF3": "sample string 10",
"Signed": true,
"SigningComplete": true,
"ClientName": "sample string 13",
"SigningRoomName": "sample string 14",
"HasAnnotations": true,
"HasSigners": true,
"Reviewed": true,
"ReviewingComplete": true,
"Downloaded": true,
"ParentDocumentId": 1,
"Status": "Complete",
"IsSmartDoc": true,
"Archived": true,
"CreatedBy": "sample string 22",
"CreatedDate": "2026-01-01T17:32:40.3616251-05:00",
"SignatureValidation": {
"Valid": true,
"InvalidReason": "sample string 2"
},
"ExternallySigned": true,
"AuthoritativeCopy": true,
"PreviousAuthoritativeCopy": true,
"MarkAsAuthoritativeCopyAfterSigning": true,
"TransferableRecord": true,
"IsTransferableDocOrSmartDoc": true,
"IsAuthoritativeDocOrSmartDoc": true,
"PrintAndSign": true,
"ENotary": true,
"SortOrder": 1,
"Signable": "eSign",
"FolderId": 1,
"ParentFolderId": 1,
"ParentFolderName": "sample string 30",
"MISMOVersionIdentifier": "sample string 31",
"SystemDocument": true
},
{
"DocumentId": 1,
"ClientId": 1,
"SigningRoomId": 1,
"DocumentTypeId": 1,
"DocumentType": "sample string 1",
"DocumentGuid": "sample string 2",
"DocumentName": "sample string 3",
"Description": "sample string 4",
"PageCount": 1,
"FileExtension": "sample string 5",
"MimeType": "sample string 6",
"IsPDF": true,
"UDF1": "sample string 8",
"UDF2": "sample string 9",
"UDF3": "sample string 10",
"Signed": true,
"SigningComplete": true,
"ClientName": "sample string 13",
"SigningRoomName": "sample string 14",
"HasAnnotations": true,
"HasSigners": true,
"Reviewed": true,
"ReviewingComplete": true,
"Downloaded": true,
"ParentDocumentId": 1,
"Status": "Complete",
"IsSmartDoc": true,
"Archived": true,
"CreatedBy": "sample string 22",
"CreatedDate": "2026-01-01T17:32:40.3616251-05:00",
"SignatureValidation": {
"Valid": true,
"InvalidReason": "sample string 2"
},
"ExternallySigned": true,
"AuthoritativeCopy": true,
"PreviousAuthoritativeCopy": true,
"MarkAsAuthoritativeCopyAfterSigning": true,
"TransferableRecord": true,
"IsTransferableDocOrSmartDoc": true,
"IsAuthoritativeDocOrSmartDoc": true,
"PrintAndSign": true,
"ENotary": true,
"SortOrder": 1,
"Signable": "eSign",
"FolderId": 1,
"ParentFolderId": 1,
"ParentFolderName": "sample string 30",
"MISMOVersionIdentifier": "sample string 31",
"SystemDocument": true
}
],
"SigningRoomAdmins": [
{
"SigningRoomAdminId": 1,
"SigningRoomId": 1,
"UserId": 1,
"Username": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4"
},
{
"SigningRoomAdminId": 1,
"SigningRoomId": 1,
"UserId": 1,
"Username": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4"
}
],
"SigningRoomActivityLogs": [
{
"SigningRoomActivityLogId": 1,
"SigningRoomId": 1,
"SigningRoomActivityTypeId": 1,
"SigningRoomActivityType": "sample string 2",
"ChangeFieldName": "sample string 3",
"NewFieldValue": "sample string 4",
"OldFieldValue": "sample string 5",
"ParticipantId": 1,
"ParticipantFirstName": "sample string 6",
"ParticipantLastName": "sample string 7",
"ParticipantEmail": "sample string 8",
"ParticipantRoleType": "sample string 9",
"ParticipantRoleTypeId": 1,
"DocumentId": 1,
"DocumentName": "sample string 10",
"UserId": 1,
"UserName": "sample string 11",
"SigningRoomName": "sample string 12",
"ClientName": "sample string 13",
"OrganizationName": "sample string 14",
"OrganizationId": 1,
"IPAddress": "sample string 15",
"UpdatedBy": "sample string 16",
"UpdatedDate": "2026-01-01T17:32:40.3616251-05:00"
},
{
"SigningRoomActivityLogId": 1,
"SigningRoomId": 1,
"SigningRoomActivityTypeId": 1,
"SigningRoomActivityType": "sample string 2",
"ChangeFieldName": "sample string 3",
"NewFieldValue": "sample string 4",
"OldFieldValue": "sample string 5",
"ParticipantId": 1,
"ParticipantFirstName": "sample string 6",
"ParticipantLastName": "sample string 7",
"ParticipantEmail": "sample string 8",
"ParticipantRoleType": "sample string 9",
"ParticipantRoleTypeId": 1,
"DocumentId": 1,
"DocumentName": "sample string 10",
"UserId": 1,
"UserName": "sample string 11",
"SigningRoomName": "sample string 12",
"ClientName": "sample string 13",
"OrganizationName": "sample string 14",
"OrganizationId": 1,
"IPAddress": "sample string 15",
"UpdatedBy": "sample string 16",
"UpdatedDate": "2026-01-01T17:32:40.3616251-05:00"
}
],
"UpdatedBy": "sample string 12",
"UpdatedDate": "2026-01-01T17:32:40.3616251-05:00"
}
application/xml, text/xml
<SigningRoomModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 12</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2026-01-01T17:32:40.3616251-05:00</UpdatedDate>
<ClientId>1</ClientId>
<ClientName>sample string 2</ClientName>
<CreatedByUserId>5</CreatedByUserId>
<Description>sample string 4</Description>
<Documents>
<DocumentModel>
<Archived>true</Archived>
<AuthoritativeCopy>true</AuthoritativeCopy>
<ClientId>1</ClientId>
<ClientName>sample string 13</ClientName>
<CreatedBy>sample string 22</CreatedBy>
<CreatedDate>2026-01-01T17:32:40.3616251-05:00</CreatedDate>
<Description>sample string 4</Description>
<DocumentGuid>sample string 2</DocumentGuid>
<DocumentId>1</DocumentId>
<DocumentName>sample string 3</DocumentName>
<DocumentType>sample string 1</DocumentType>
<DocumentTypeId>1</DocumentTypeId>
<Downloaded>true</Downloaded>
<ENotary>true</ENotary>
<ExternallySigned>true</ExternallySigned>
<FileExtension>sample string 5</FileExtension>
<FolderId>1</FolderId>
<HasAnnotations>true</HasAnnotations>
<HasSigners>true</HasSigners>
<IsAuthoritativeDocOrSmartDoc>true</IsAuthoritativeDocOrSmartDoc>
<IsPDF>true</IsPDF>
<IsSmartDoc>true</IsSmartDoc>
<IsTransferableDocOrSmartDoc>true</IsTransferableDocOrSmartDoc>
<MISMOVersionIdentifier>sample string 31</MISMOVersionIdentifier>
<MarkAsAuthoritativeCopyAfterSigning>true</MarkAsAuthoritativeCopyAfterSigning>
<MimeType>sample string 6</MimeType>
<PageCount>1</PageCount>
<ParentDocumentId>1</ParentDocumentId>
<ParentFolderId>1</ParentFolderId>
<ParentFolderName>sample string 30</ParentFolderName>
<PreviousAuthoritativeCopy>true</PreviousAuthoritativeCopy>
<PrintAndSign>true</PrintAndSign>
<Reviewed>true</Reviewed>
<ReviewingComplete>true</ReviewingComplete>
<SignatureValidation xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
<d4p1:InvalidReason>sample string 2</d4p1:InvalidReason>
<d4p1:Valid>true</d4p1:Valid>
</SignatureValidation>
<Signed>true</Signed>
<SigningComplete>true</SigningComplete>
<SigningRoomId>1</SigningRoomId>
<SigningRoomName>sample string 14</SigningRoomName>
<SortOrder>1</SortOrder>
<SystemDocument>true</SystemDocument>
<TransferableRecord>true</TransferableRecord>
<UDF1>sample string 8</UDF1>
<UDF2>sample string 9</UDF2>
<UDF3>sample string 10</UDF3>
</DocumentModel>
<DocumentModel>
<Archived>true</Archived>
<AuthoritativeCopy>true</AuthoritativeCopy>
<ClientId>1</ClientId>
<ClientName>sample string 13</ClientName>
<CreatedBy>sample string 22</CreatedBy>
<CreatedDate>2026-01-01T17:32:40.3616251-05:00</CreatedDate>
<Description>sample string 4</Description>
<DocumentGuid>sample string 2</DocumentGuid>
<DocumentId>1</DocumentId>
<DocumentName>sample string 3</DocumentName>
<DocumentType>sample string 1</DocumentType>
<DocumentTypeId>1</DocumentTypeId>
<Downloaded>true</Downloaded>
<ENotary>true</ENotary>
<ExternallySigned>true</ExternallySigned>
<FileExtension>sample string 5</FileExtension>
<FolderId>1</FolderId>
<HasAnnotations>true</HasAnnotations>
<HasSigners>true</HasSigners>
<IsAuthoritativeDocOrSmartDoc>true</IsAuthoritativeDocOrSmartDoc>
<IsPDF>true</IsPDF>
<IsSmartDoc>true</IsSmartDoc>
<IsTransferableDocOrSmartDoc>true</IsTransferableDocOrSmartDoc>
<MISMOVersionIdentifier>sample string 31</MISMOVersionIdentifier>
<MarkAsAuthoritativeCopyAfterSigning>true</MarkAsAuthoritativeCopyAfterSigning>
<MimeType>sample string 6</MimeType>
<PageCount>1</PageCount>
<ParentDocumentId>1</ParentDocumentId>
<ParentFolderId>1</ParentFolderId>
<ParentFolderName>sample string 30</ParentFolderName>
<PreviousAuthoritativeCopy>true</PreviousAuthoritativeCopy>
<PrintAndSign>true</PrintAndSign>
<Reviewed>true</Reviewed>
<ReviewingComplete>true</ReviewingComplete>
<SignatureValidation xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
<d4p1:InvalidReason>sample string 2</d4p1:InvalidReason>
<d4p1:Valid>true</d4p1:Valid>
</SignatureValidation>
<Signed>true</Signed>
<SigningComplete>true</SigningComplete>
<SigningRoomId>1</SigningRoomId>
<SigningRoomName>sample string 14</SigningRoomName>
<SortOrder>1</SortOrder>
<SystemDocument>true</SystemDocument>
<TransferableRecord>true</TransferableRecord>
<UDF1>sample string 8</UDF1>
<UDF2>sample string 9</UDF2>
<UDF3>sample string 10</UDF3>
</DocumentModel>
</Documents>
<EnableSigningRoomInvitations>true</EnableSigningRoomInvitations>
<ExpirationDate i:nil="true" />
<Participants>
<ParticipantModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 11</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2026-01-01T17:32:40.3616251-05:00</UpdatedDate>
<AccessCode>sample string 7</AccessCode>
<Deleted>true</Deleted>
<ESignConsentAccepted>true</ESignConsentAccepted>
<FirstName>sample string 1</FirstName>
<FullName>sample string 3</FullName>
<Initials>sample string 4</Initials>
<InvitationCode>sample string 6</InvitationCode>
<InvitationEmail>sample string 5</InvitationEmail>
<LastName>sample string 2</LastName>
<ParticipantId>1</ParticipantId>
<ParticipantRoleTypeId>1</ParticipantRoleTypeId>
<SigningRoomId>1</SigningRoomId>
<SigningRoomUrl>sample string 8</SigningRoomUrl>
<SortOrder>1</SortOrder>
</ParticipantModel>
<ParticipantModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 11</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2026-01-01T17:32:40.3616251-05:00</UpdatedDate>
<AccessCode>sample string 7</AccessCode>
<Deleted>true</Deleted>
<ESignConsentAccepted>true</ESignConsentAccepted>
<FirstName>sample string 1</FirstName>
<FullName>sample string 3</FullName>
<Initials>sample string 4</Initials>
<InvitationCode>sample string 6</InvitationCode>
<InvitationEmail>sample string 5</InvitationEmail>
<LastName>sample string 2</LastName>
<ParticipantId>1</ParticipantId>
<ParticipantRoleTypeId>1</ParticipantRoleTypeId>
<SigningRoomId>1</SigningRoomId>
<SigningRoomUrl>sample string 8</SigningRoomUrl>
<SortOrder>1</SortOrder>
</ParticipantModel>
</Participants>
<ServerTimeZone>sample string 10</ServerTimeZone>
<SigningDate i:nil="true" />
<SigningRoomActivityLogs>
<SigningRoomActivityLogModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 16</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2026-01-01T17:32:40.3616251-05:00</UpdatedDate>
<ChangeFieldName>sample string 3</ChangeFieldName>
<ClientName>sample string 13</ClientName>
<DocumentId>1</DocumentId>
<DocumentName>sample string 10</DocumentName>
<IPAddress>sample string 15</IPAddress>
<NewFieldValue>sample string 4</NewFieldValue>
<OldFieldValue>sample string 5</OldFieldValue>
<OrganizationId>1</OrganizationId>
<OrganizationName>sample string 14</OrganizationName>
<ParticipantEmail>sample string 8</ParticipantEmail>
<ParticipantFirstName>sample string 6</ParticipantFirstName>
<ParticipantId>1</ParticipantId>
<ParticipantLastName>sample string 7</ParticipantLastName>
<ParticipantRoleType>sample string 9</ParticipantRoleType>
<ParticipantRoleTypeId>1</ParticipantRoleTypeId>
<SigningRoomActivityLogId>1</SigningRoomActivityLogId>
<SigningRoomActivityType>sample string 2</SigningRoomActivityType>
<SigningRoomActivityTypeId>1</SigningRoomActivityTypeId>
<SigningRoomId>1</SigningRoomId>
<SigningRoomName>sample string 12</SigningRoomName>
<UserId>1</UserId>
<UserName>sample string 11</UserName>
</SigningRoomActivityLogModel>
<SigningRoomActivityLogModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 16</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2026-01-01T17:32:40.3616251-05:00</UpdatedDate>
<ChangeFieldName>sample string 3</ChangeFieldName>
<ClientName>sample string 13</ClientName>
<DocumentId>1</DocumentId>
<DocumentName>sample string 10</DocumentName>
<IPAddress>sample string 15</IPAddress>
<NewFieldValue>sample string 4</NewFieldValue>
<OldFieldValue>sample string 5</OldFieldValue>
<OrganizationId>1</OrganizationId>
<OrganizationName>sample string 14</OrganizationName>
<ParticipantEmail>sample string 8</ParticipantEmail>
<ParticipantFirstName>sample string 6</ParticipantFirstName>
<ParticipantId>1</ParticipantId>
<ParticipantLastName>sample string 7</ParticipantLastName>
<ParticipantRoleType>sample string 9</ParticipantRoleType>
<ParticipantRoleTypeId>1</ParticipantRoleTypeId>
<SigningRoomActivityLogId>1</SigningRoomActivityLogId>
<SigningRoomActivityType>sample string 2</SigningRoomActivityType>
<SigningRoomActivityTypeId>1</SigningRoomActivityTypeId>
<SigningRoomId>1</SigningRoomId>
<SigningRoomName>sample string 12</SigningRoomName>
<UserId>1</UserId>
<UserName>sample string 11</UserName>
</SigningRoomActivityLogModel>
</SigningRoomActivityLogs>
<SigningRoomAdmins>
<SigningRoomAdminModel>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<LastName>sample string 3</LastName>
<SigningRoomAdminId>1</SigningRoomAdminId>
<SigningRoomId>1</SigningRoomId>
<UserId>1</UserId>
<Username>sample string 1</Username>
</SigningRoomAdminModel>
<SigningRoomAdminModel>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<LastName>sample string 3</LastName>
<SigningRoomAdminId>1</SigningRoomAdminId>
<SigningRoomId>1</SigningRoomId>
<UserId>1</UserId>
<Username>sample string 1</Username>
</SigningRoomAdminModel>
</SigningRoomAdmins>
<SigningRoomGuid>sample string 1</SigningRoomGuid>
<SigningRoomId>1</SigningRoomId>
<SigningRoomName>sample string 3</SigningRoomName>
<StartDate i:nil="true" />
<Status>sample string 11</Status>
</SigningRoomModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The updateed SigningRoom.
ESignSystems.SmartSAFE.Models.SigningRoomManager.SigningRoomModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SigningRoomId |
Gets or sets the SigningRoom identifier. |
integer |
None. |
| SigningRoomGuid |
Gets or sets the SigningRoom GUID. |
string |
None. |
| ClientId |
Gets or sets the SigningRoom's client identifier. |
integer |
None. |
| ClientName |
Gets or sets the client's name. |
string |
None. |
| SigningRoomName |
Gets or sets the SigningRoom's name. |
string |
Required Max length: 256 |
| Description |
Gets or sets the SigningRoom's description. |
string |
Max length: 500 |
| CreatedByUserId |
Gets or sets the SigningRoom creator identifier. |
integer |
None. |
| EnableSigningRoomInvitations |
Gets or sets the enable signing room invitations bool. |
boolean |
None. |
| StartDate |
Gets or sets a string representing the date and time that the SigningRoom starts. |
string |
Required Data type: DateTime |
| Expired |
Gets a value indicating whether the SigningRoom has expired. |
boolean |
None. |
| ExpirationDate |
Gets or sets a string representing the date and time that the SigningRoom expires. |
string |
Data type: Date |
| SigningDate |
Gets or sets a string representing the date and time that the SigningRoom signs. |
string |
Data type: Date |
| ServerTimeZone |
Gets or sets the time zone of the server. |
string |
None. |
| Status |
Gets or sets the SigningRoom status. |
string |
None. |
| Participants |
Gets or sets the list of participants associated to the SigningRoom. |
Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.ParticipantModel |
None. |
| Documents |
Gets or sets the list of documents associated to the SigningRoom. |
Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.DocumentModel |
None. |
| SigningRoomAdmins |
Gets or sets the list of SigningRoom admin associated to the SigningRoom. |
Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.SigningRoomAdminModel |
None. |
| SigningRoomActivityLogs |
Gets or sets the list of SigningRoom activity logs associated to the SigningRoom. |
Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.SigningRoomActivityLogModel |
None. |
| UpdatedBy |
Gets or sets the name of the user that updated the model. |
string |
None. |
| UpdatedDate |
Gets or sets the date an time that the model was updated. |
date |
None. |
Response Formats
application/json, text/json
{
"SigningRoomId": 1,
"SigningRoomGuid": "sample string 1",
"ClientId": 1,
"ClientName": "sample string 2",
"SigningRoomName": "sample string 3",
"Description": "sample string 4",
"CreatedByUserId": 5,
"EnableSigningRoomInvitations": true,
"Expired": false,
"ServerTimeZone": "sample string 10",
"Status": "sample string 11",
"Participants": [
{
"ParticipantId": 1,
"SigningRoomId": 1,
"SortOrder": 1,
"ParticipantRoleTypeId": 1,
"FirstName": "sample string 1",
"LastName": "sample string 2",
"FullName": "sample string 3",
"Initials": "sample string 4",
"InvitationEmail": "sample string 5",
"InvitationCode": "sample string 6",
"AccessCode": "sample string 7",
"SigningRoomUrl": "sample string 8",
"ESignConsentAccepted": true,
"Deleted": true,
"UpdatedBy": "sample string 11",
"UpdatedDate": "2026-01-01T17:32:40.3772231-05:00"
},
{
"ParticipantId": 1,
"SigningRoomId": 1,
"SortOrder": 1,
"ParticipantRoleTypeId": 1,
"FirstName": "sample string 1",
"LastName": "sample string 2",
"FullName": "sample string 3",
"Initials": "sample string 4",
"InvitationEmail": "sample string 5",
"InvitationCode": "sample string 6",
"AccessCode": "sample string 7",
"SigningRoomUrl": "sample string 8",
"ESignConsentAccepted": true,
"Deleted": true,
"UpdatedBy": "sample string 11",
"UpdatedDate": "2026-01-01T17:32:40.3772231-05:00"
}
],
"Documents": [
{
"DocumentId": 1,
"ClientId": 1,
"SigningRoomId": 1,
"DocumentTypeId": 1,
"DocumentType": "sample string 1",
"DocumentGuid": "sample string 2",
"DocumentName": "sample string 3",
"Description": "sample string 4",
"PageCount": 1,
"FileExtension": "sample string 5",
"MimeType": "sample string 6",
"IsPDF": true,
"UDF1": "sample string 8",
"UDF2": "sample string 9",
"UDF3": "sample string 10",
"Signed": true,
"SigningComplete": true,
"ClientName": "sample string 13",
"SigningRoomName": "sample string 14",
"HasAnnotations": true,
"HasSigners": true,
"Reviewed": true,
"ReviewingComplete": true,
"Downloaded": true,
"ParentDocumentId": 1,
"Status": "Complete",
"IsSmartDoc": true,
"Archived": true,
"CreatedBy": "sample string 22",
"CreatedDate": "2026-01-01T17:32:40.3772231-05:00",
"SignatureValidation": {
"Valid": true,
"InvalidReason": "sample string 2"
},
"ExternallySigned": true,
"AuthoritativeCopy": true,
"PreviousAuthoritativeCopy": true,
"MarkAsAuthoritativeCopyAfterSigning": true,
"TransferableRecord": true,
"IsTransferableDocOrSmartDoc": true,
"IsAuthoritativeDocOrSmartDoc": true,
"PrintAndSign": true,
"ENotary": true,
"SortOrder": 1,
"Signable": "eSign",
"FolderId": 1,
"ParentFolderId": 1,
"ParentFolderName": "sample string 30",
"MISMOVersionIdentifier": "sample string 31",
"SystemDocument": true
},
{
"DocumentId": 1,
"ClientId": 1,
"SigningRoomId": 1,
"DocumentTypeId": 1,
"DocumentType": "sample string 1",
"DocumentGuid": "sample string 2",
"DocumentName": "sample string 3",
"Description": "sample string 4",
"PageCount": 1,
"FileExtension": "sample string 5",
"MimeType": "sample string 6",
"IsPDF": true,
"UDF1": "sample string 8",
"UDF2": "sample string 9",
"UDF3": "sample string 10",
"Signed": true,
"SigningComplete": true,
"ClientName": "sample string 13",
"SigningRoomName": "sample string 14",
"HasAnnotations": true,
"HasSigners": true,
"Reviewed": true,
"ReviewingComplete": true,
"Downloaded": true,
"ParentDocumentId": 1,
"Status": "Complete",
"IsSmartDoc": true,
"Archived": true,
"CreatedBy": "sample string 22",
"CreatedDate": "2026-01-01T17:32:40.3772231-05:00",
"SignatureValidation": {
"Valid": true,
"InvalidReason": "sample string 2"
},
"ExternallySigned": true,
"AuthoritativeCopy": true,
"PreviousAuthoritativeCopy": true,
"MarkAsAuthoritativeCopyAfterSigning": true,
"TransferableRecord": true,
"IsTransferableDocOrSmartDoc": true,
"IsAuthoritativeDocOrSmartDoc": true,
"PrintAndSign": true,
"ENotary": true,
"SortOrder": 1,
"Signable": "eSign",
"FolderId": 1,
"ParentFolderId": 1,
"ParentFolderName": "sample string 30",
"MISMOVersionIdentifier": "sample string 31",
"SystemDocument": true
}
],
"SigningRoomAdmins": [
{
"SigningRoomAdminId": 1,
"SigningRoomId": 1,
"UserId": 1,
"Username": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4"
},
{
"SigningRoomAdminId": 1,
"SigningRoomId": 1,
"UserId": 1,
"Username": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4"
}
],
"SigningRoomActivityLogs": [
{
"SigningRoomActivityLogId": 1,
"SigningRoomId": 1,
"SigningRoomActivityTypeId": 1,
"SigningRoomActivityType": "sample string 2",
"ChangeFieldName": "sample string 3",
"NewFieldValue": "sample string 4",
"OldFieldValue": "sample string 5",
"ParticipantId": 1,
"ParticipantFirstName": "sample string 6",
"ParticipantLastName": "sample string 7",
"ParticipantEmail": "sample string 8",
"ParticipantRoleType": "sample string 9",
"ParticipantRoleTypeId": 1,
"DocumentId": 1,
"DocumentName": "sample string 10",
"UserId": 1,
"UserName": "sample string 11",
"SigningRoomName": "sample string 12",
"ClientName": "sample string 13",
"OrganizationName": "sample string 14",
"OrganizationId": 1,
"IPAddress": "sample string 15",
"UpdatedBy": "sample string 16",
"UpdatedDate": "2026-01-01T17:32:40.3772231-05:00"
},
{
"SigningRoomActivityLogId": 1,
"SigningRoomId": 1,
"SigningRoomActivityTypeId": 1,
"SigningRoomActivityType": "sample string 2",
"ChangeFieldName": "sample string 3",
"NewFieldValue": "sample string 4",
"OldFieldValue": "sample string 5",
"ParticipantId": 1,
"ParticipantFirstName": "sample string 6",
"ParticipantLastName": "sample string 7",
"ParticipantEmail": "sample string 8",
"ParticipantRoleType": "sample string 9",
"ParticipantRoleTypeId": 1,
"DocumentId": 1,
"DocumentName": "sample string 10",
"UserId": 1,
"UserName": "sample string 11",
"SigningRoomName": "sample string 12",
"ClientName": "sample string 13",
"OrganizationName": "sample string 14",
"OrganizationId": 1,
"IPAddress": "sample string 15",
"UpdatedBy": "sample string 16",
"UpdatedDate": "2026-01-01T17:32:40.3772231-05:00"
}
],
"UpdatedBy": "sample string 12",
"UpdatedDate": "2026-01-01T17:32:40.3772231-05:00"
}
application/xml, text/xml
<SigningRoomModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 12</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2026-01-01T17:32:40.3772231-05:00</UpdatedDate>
<ClientId>1</ClientId>
<ClientName>sample string 2</ClientName>
<CreatedByUserId>5</CreatedByUserId>
<Description>sample string 4</Description>
<Documents>
<DocumentModel>
<Archived>true</Archived>
<AuthoritativeCopy>true</AuthoritativeCopy>
<ClientId>1</ClientId>
<ClientName>sample string 13</ClientName>
<CreatedBy>sample string 22</CreatedBy>
<CreatedDate>2026-01-01T17:32:40.3772231-05:00</CreatedDate>
<Description>sample string 4</Description>
<DocumentGuid>sample string 2</DocumentGuid>
<DocumentId>1</DocumentId>
<DocumentName>sample string 3</DocumentName>
<DocumentType>sample string 1</DocumentType>
<DocumentTypeId>1</DocumentTypeId>
<Downloaded>true</Downloaded>
<ENotary>true</ENotary>
<ExternallySigned>true</ExternallySigned>
<FileExtension>sample string 5</FileExtension>
<FolderId>1</FolderId>
<HasAnnotations>true</HasAnnotations>
<HasSigners>true</HasSigners>
<IsAuthoritativeDocOrSmartDoc>true</IsAuthoritativeDocOrSmartDoc>
<IsPDF>true</IsPDF>
<IsSmartDoc>true</IsSmartDoc>
<IsTransferableDocOrSmartDoc>true</IsTransferableDocOrSmartDoc>
<MISMOVersionIdentifier>sample string 31</MISMOVersionIdentifier>
<MarkAsAuthoritativeCopyAfterSigning>true</MarkAsAuthoritativeCopyAfterSigning>
<MimeType>sample string 6</MimeType>
<PageCount>1</PageCount>
<ParentDocumentId>1</ParentDocumentId>
<ParentFolderId>1</ParentFolderId>
<ParentFolderName>sample string 30</ParentFolderName>
<PreviousAuthoritativeCopy>true</PreviousAuthoritativeCopy>
<PrintAndSign>true</PrintAndSign>
<Reviewed>true</Reviewed>
<ReviewingComplete>true</ReviewingComplete>
<SignatureValidation xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
<d4p1:InvalidReason>sample string 2</d4p1:InvalidReason>
<d4p1:Valid>true</d4p1:Valid>
</SignatureValidation>
<Signed>true</Signed>
<SigningComplete>true</SigningComplete>
<SigningRoomId>1</SigningRoomId>
<SigningRoomName>sample string 14</SigningRoomName>
<SortOrder>1</SortOrder>
<SystemDocument>true</SystemDocument>
<TransferableRecord>true</TransferableRecord>
<UDF1>sample string 8</UDF1>
<UDF2>sample string 9</UDF2>
<UDF3>sample string 10</UDF3>
</DocumentModel>
<DocumentModel>
<Archived>true</Archived>
<AuthoritativeCopy>true</AuthoritativeCopy>
<ClientId>1</ClientId>
<ClientName>sample string 13</ClientName>
<CreatedBy>sample string 22</CreatedBy>
<CreatedDate>2026-01-01T17:32:40.3772231-05:00</CreatedDate>
<Description>sample string 4</Description>
<DocumentGuid>sample string 2</DocumentGuid>
<DocumentId>1</DocumentId>
<DocumentName>sample string 3</DocumentName>
<DocumentType>sample string 1</DocumentType>
<DocumentTypeId>1</DocumentTypeId>
<Downloaded>true</Downloaded>
<ENotary>true</ENotary>
<ExternallySigned>true</ExternallySigned>
<FileExtension>sample string 5</FileExtension>
<FolderId>1</FolderId>
<HasAnnotations>true</HasAnnotations>
<HasSigners>true</HasSigners>
<IsAuthoritativeDocOrSmartDoc>true</IsAuthoritativeDocOrSmartDoc>
<IsPDF>true</IsPDF>
<IsSmartDoc>true</IsSmartDoc>
<IsTransferableDocOrSmartDoc>true</IsTransferableDocOrSmartDoc>
<MISMOVersionIdentifier>sample string 31</MISMOVersionIdentifier>
<MarkAsAuthoritativeCopyAfterSigning>true</MarkAsAuthoritativeCopyAfterSigning>
<MimeType>sample string 6</MimeType>
<PageCount>1</PageCount>
<ParentDocumentId>1</ParentDocumentId>
<ParentFolderId>1</ParentFolderId>
<ParentFolderName>sample string 30</ParentFolderName>
<PreviousAuthoritativeCopy>true</PreviousAuthoritativeCopy>
<PrintAndSign>true</PrintAndSign>
<Reviewed>true</Reviewed>
<ReviewingComplete>true</ReviewingComplete>
<SignatureValidation xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
<d4p1:InvalidReason>sample string 2</d4p1:InvalidReason>
<d4p1:Valid>true</d4p1:Valid>
</SignatureValidation>
<Signed>true</Signed>
<SigningComplete>true</SigningComplete>
<SigningRoomId>1</SigningRoomId>
<SigningRoomName>sample string 14</SigningRoomName>
<SortOrder>1</SortOrder>
<SystemDocument>true</SystemDocument>
<TransferableRecord>true</TransferableRecord>
<UDF1>sample string 8</UDF1>
<UDF2>sample string 9</UDF2>
<UDF3>sample string 10</UDF3>
</DocumentModel>
</Documents>
<EnableSigningRoomInvitations>true</EnableSigningRoomInvitations>
<ExpirationDate i:nil="true" />
<Participants>
<ParticipantModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 11</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2026-01-01T17:32:40.3772231-05:00</UpdatedDate>
<AccessCode>sample string 7</AccessCode>
<Deleted>true</Deleted>
<ESignConsentAccepted>true</ESignConsentAccepted>
<FirstName>sample string 1</FirstName>
<FullName>sample string 3</FullName>
<Initials>sample string 4</Initials>
<InvitationCode>sample string 6</InvitationCode>
<InvitationEmail>sample string 5</InvitationEmail>
<LastName>sample string 2</LastName>
<ParticipantId>1</ParticipantId>
<ParticipantRoleTypeId>1</ParticipantRoleTypeId>
<SigningRoomId>1</SigningRoomId>
<SigningRoomUrl>sample string 8</SigningRoomUrl>
<SortOrder>1</SortOrder>
</ParticipantModel>
<ParticipantModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 11</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2026-01-01T17:32:40.3772231-05:00</UpdatedDate>
<AccessCode>sample string 7</AccessCode>
<Deleted>true</Deleted>
<ESignConsentAccepted>true</ESignConsentAccepted>
<FirstName>sample string 1</FirstName>
<FullName>sample string 3</FullName>
<Initials>sample string 4</Initials>
<InvitationCode>sample string 6</InvitationCode>
<InvitationEmail>sample string 5</InvitationEmail>
<LastName>sample string 2</LastName>
<ParticipantId>1</ParticipantId>
<ParticipantRoleTypeId>1</ParticipantRoleTypeId>
<SigningRoomId>1</SigningRoomId>
<SigningRoomUrl>sample string 8</SigningRoomUrl>
<SortOrder>1</SortOrder>
</ParticipantModel>
</Participants>
<ServerTimeZone>sample string 10</ServerTimeZone>
<SigningDate i:nil="true" />
<SigningRoomActivityLogs>
<SigningRoomActivityLogModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 16</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2026-01-01T17:32:40.3772231-05:00</UpdatedDate>
<ChangeFieldName>sample string 3</ChangeFieldName>
<ClientName>sample string 13</ClientName>
<DocumentId>1</DocumentId>
<DocumentName>sample string 10</DocumentName>
<IPAddress>sample string 15</IPAddress>
<NewFieldValue>sample string 4</NewFieldValue>
<OldFieldValue>sample string 5</OldFieldValue>
<OrganizationId>1</OrganizationId>
<OrganizationName>sample string 14</OrganizationName>
<ParticipantEmail>sample string 8</ParticipantEmail>
<ParticipantFirstName>sample string 6</ParticipantFirstName>
<ParticipantId>1</ParticipantId>
<ParticipantLastName>sample string 7</ParticipantLastName>
<ParticipantRoleType>sample string 9</ParticipantRoleType>
<ParticipantRoleTypeId>1</ParticipantRoleTypeId>
<SigningRoomActivityLogId>1</SigningRoomActivityLogId>
<SigningRoomActivityType>sample string 2</SigningRoomActivityType>
<SigningRoomActivityTypeId>1</SigningRoomActivityTypeId>
<SigningRoomId>1</SigningRoomId>
<SigningRoomName>sample string 12</SigningRoomName>
<UserId>1</UserId>
<UserName>sample string 11</UserName>
</SigningRoomActivityLogModel>
<SigningRoomActivityLogModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 16</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2026-01-01T17:32:40.3772231-05:00</UpdatedDate>
<ChangeFieldName>sample string 3</ChangeFieldName>
<ClientName>sample string 13</ClientName>
<DocumentId>1</DocumentId>
<DocumentName>sample string 10</DocumentName>
<IPAddress>sample string 15</IPAddress>
<NewFieldValue>sample string 4</NewFieldValue>
<OldFieldValue>sample string 5</OldFieldValue>
<OrganizationId>1</OrganizationId>
<OrganizationName>sample string 14</OrganizationName>
<ParticipantEmail>sample string 8</ParticipantEmail>
<ParticipantFirstName>sample string 6</ParticipantFirstName>
<ParticipantId>1</ParticipantId>
<ParticipantLastName>sample string 7</ParticipantLastName>
<ParticipantRoleType>sample string 9</ParticipantRoleType>
<ParticipantRoleTypeId>1</ParticipantRoleTypeId>
<SigningRoomActivityLogId>1</SigningRoomActivityLogId>
<SigningRoomActivityType>sample string 2</SigningRoomActivityType>
<SigningRoomActivityTypeId>1</SigningRoomActivityTypeId>
<SigningRoomId>1</SigningRoomId>
<SigningRoomName>sample string 12</SigningRoomName>
<UserId>1</UserId>
<UserName>sample string 11</UserName>
</SigningRoomActivityLogModel>
</SigningRoomActivityLogs>
<SigningRoomAdmins>
<SigningRoomAdminModel>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<LastName>sample string 3</LastName>
<SigningRoomAdminId>1</SigningRoomAdminId>
<SigningRoomId>1</SigningRoomId>
<UserId>1</UserId>
<Username>sample string 1</Username>
</SigningRoomAdminModel>
<SigningRoomAdminModel>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<LastName>sample string 3</LastName>
<SigningRoomAdminId>1</SigningRoomAdminId>
<SigningRoomId>1</SigningRoomId>
<UserId>1</UserId>
<Username>sample string 1</Username>
</SigningRoomAdminModel>
</SigningRoomAdmins>
<SigningRoomGuid>sample string 1</SigningRoomGuid>
<SigningRoomId>1</SigningRoomId>
<SigningRoomName>sample string 3</SigningRoomName>
<StartDate i:nil="true" />
<Status>sample string 11</Status>
</SigningRoomModel>