### Get Template Details Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Fetches detailed information for a specific template using its unique GUID. ```csharp using RightSignature; ITemplate templateApi = new TemplateApi(); // Get details for a specific template string templateGuid = "a_2915_20cd89c8ab494d5f9edb3c34dd05f1c2"; string details = templateApi.GetTemplateDetails(templateGuid); Console.WriteLine(details); ``` -------------------------------- ### Prepackage a Template Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Prepares one or more templates for document creation, returning a new GUID for the package. ```csharp using RightSignature; ITemplate templateApi = new TemplateApi(); // Prepackage a single template string templateGuid = "a_2915_20cd89c8ab494d5f9edb3c34dd05f1c2"; string prepackagedXml = templateApi.PrepackageTemplate(templateGuid); Console.WriteLine(prepackagedXml); // Prepackage multiple templates (comma-separated GUIDs) string multipleGuids = "template_guid_1,template_guid_2,template_guid_3"; string combinedPackage = templateApi.PrepackageTemplate(multipleGuids); Console.WriteLine(combinedPackage); // Extract the new GUID from the prepackaged response string newGuid = ApiHelper.getGuid(prepackagedXml, "template"); Console.WriteLine("Prepackaged GUID: " + newGuid); ``` -------------------------------- ### Get Template Details Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Retrieves detailed information about a specific template using its GUID. ```APIDOC ## GetTemplateDetails - Get Template Details ### Description Retrieve detailed information about a specific template using its GUID. ### Method GET ### Endpoint `/templates/{templateGuid}` ### Parameters #### Path Parameters - **templateGuid** (string) - Required - The unique identifier of the template. ### Response (The C# example returns a string, likely a JSON object with template details.) #### Success Response (200) - **templateDetails** (object) - An object containing detailed information about the template. ``` -------------------------------- ### Complete Workflow: Prepackage Template and Send with Embedded Signing Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt This example shows the typical workflow of prepackaging a template and sending it for signature with embedded signing enabled. Ensure API is initialized and API instances are created before execution. ```csharp using RightSignature; using System; using System.Collections.Generic; class Program { static void Main(string[] args) { // Initialize the API ApiHelper.Initialize(); // Create API instances IDocument docApi = new DocumentApi(); ITemplate templateApi = new TemplateApi(); // Define recipients/roles List recipients = new List(); recipients.Add(new Structs.Recipient( "RightSignature", "sender@company.com", "Document Sender", true, // is_sender true // locked )); recipients.Add(new Structs.Recipient( "John Bellingham", "john@client.com", "Receiver", false, true )); // Define tags Dictionary tags = new Dictionary(); tags.Add("project", "onboarding"); tags.Add("client_id", "12345"); // Prepackage the template string templateGuid = "a_2915_20cd89c8ab494d5f9edb3c34dd05f1c2"; string prepackagedXml = templateApi.PrepackageTemplate(templateGuid); string prepackagedGuid = ApiHelper.getGuid(prepackagedXml, "template"); // Send as document with embedded signing string result = templateApi.PreFillORSendAsDocument( guid: prepackagedGuid, subject: "Please sign the agreement", action: "send", roles: recipients, mergeFields: null, tags: tags, expires_in: 30, description: null, callbackURL: null, embedded_signing: true ); Console.WriteLine("Document sent successfully!"); Console.WriteLine(result); // The result contains signer links for embedding in your application } } ``` -------------------------------- ### Prepackage a Template Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Prepackages one or more templates for sending as a document, returning a new GUID for the prepackaged template. ```APIDOC ## PrepackageTemplate - Prepackage a Template ### Description Prepackage one or more templates to prepare them for sending as a document. Returns a new GUID for the prepackaged template. ### Method POST (Assumed, as it creates a new resource) ### Endpoint `/templates/prepackage` (Assumed structure) ### Parameters #### Request Body - **templateGuids** (string) - Required - A comma-separated string of template GUIDs to prepackage. Can be a single GUID. ### Request Example (For a single template) `"a_2915_20cd89c8ab494d5f9edb3c34dd05f1c2"` (For multiple templates) `"template_guid_1,template_guid_2,template_guid_3"` ### Response (The C# example returns a string, likely XML containing the new GUID.) #### Success Response (200) - **prepackagedXml** (string) - An XML string containing the new GUID for the prepackaged template. ``` -------------------------------- ### Get Document Details - C# Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Retrieve detailed information for a specific document by providing its unique GUID. The response includes status, recipient information, and the audit trail. ```csharp using RightSignature; IDocument doc = new DocumentApi(); // Get details for a specific document by GUID string documentGuid = "Y9TLYJJ335DU5EXZLNBYG9"; string details = doc.GetDocumentDetails(documentGuid); Console.WriteLine(details); // Example XML response includes: status, recipients, audit trail, etc. ``` -------------------------------- ### GET /documents/{guid}/signer-links Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Retrieves embedded signing links for a specific document, enabling signers to complete the process within your application. ```APIDOC ## GET /documents/{guid}/signer-links ### Description Retrieves embedded signing links for a document. ### Method GET ### Endpoint /documents/{guid}/signer-links ### Parameters #### Path Parameters - **guid** (string) - Required - The unique identifier of the document. ### Response #### Success Response (200) - **signer-links** (XML) - Contains a list of signer-link elements with name, role, and URL. ``` -------------------------------- ### Send Document via Base64 - C# Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt This example shows how to send a document for signature by encoding its content as a base64 string. The `url` parameter in this case should be the local file path, which will be encoded. Set `embedded_signing` to `true` to receive signer links for embedded signing. ```csharp // Send document from local file (base64 encoded) string base64Result = doc.SendDocument( type: "base64", url: @"C:\Documents\contract.pdf", // Local file path (will be base64 encoded) subject: "Contract for Signature", fileName: "contract.pdf", recipients: recipients, action: "send", embedded_signing: true // Returns signer links for embedded signing ); Console.WriteLine(base64Result); // Output includes signer-links with embedded signing URLs ``` -------------------------------- ### Extract GUIDs from API Responses Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Uses the ApiHelper utility to parse specific GUIDs from XML-formatted API response strings. ```csharp using RightSignature; // Extract document GUID from SendDocument response string documentResponse = doc.SendDocument(...); string documentGuid = ApiHelper.getGuid(documentResponse, "document"); Console.WriteLine("Document GUID: " + documentGuid); // Extract template GUID from PrepackageTemplate response string templateResponse = templateApi.PrepackageTemplate("template_guid"); string templateGuid = ApiHelper.getGuid(templateResponse, "template"); Console.WriteLine("Template GUID: " + templateGuid); ``` -------------------------------- ### Retrieve Embedded Signing Links Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Fetches the embedded signing URLs for a specific document GUID to enable in-app signing. ```csharp using RightSignature; // Get signer links for embedded signing string documentGuid = "TN4ZLPIZ24HBTYIZ7BZF77"; string signerLinks = ApiHelper.GetSignerLinks(documentGuid); Console.WriteLine(signerLinks); // Example response: // // TN4ZLPIZ24HBTYIZ7BZF77 // // // John Smith // Signer // https://rightsignature.com/signatures/embedded?rt=... // // // ``` -------------------------------- ### GetDocumentDetails API Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Retrieve detailed information about a specific document using its GUID. ```APIDOC ## GetDocumentDetails - Get Document Details ### Description Retrieve detailed information about a specific document using its GUID. ### Method GET ### Endpoint /documents/{document_guid} ### Parameters #### Path Parameters - **document_guid** (string) - Required - The unique identifier (GUID) of the document. ### Response #### Success Response (200) - **guid** (string) - The unique identifier for the document. - **status** (string) - The current status of the document. - **recipients** (array) - List of recipients and their details. - **audit_trail** (array) - Log of actions performed on the document. #### Response Example ```xml Y9TLYJJ335DU5EXZLNBYG9 completed ... ... ``` ``` -------------------------------- ### Delete Document - C# Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Move a document to the trash by providing its GUID. Once moved to trash, the document will no longer be available for signature. ```csharp using RightSignature; IDocument doc = new DocumentApi(); // Trash a document by GUID string documentGuid = "Y9TLYJJ335DU5EXZLNBYG9"; string result = doc.DeleteDocument(documentGuid); Console.WriteLine(result); ``` -------------------------------- ### Extend Document Expiration Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Extends the expiration date of a document by 7 days using its GUID. ```csharp using RightSignature; IDocument doc = new DocumentApi(); // Extend expiration for a document string documentGuid = "Y9TLYJJ335DU5EXZLNBYG9"; string result = doc.ExtendExpiration(documentGuid); Console.WriteLine(result); ``` -------------------------------- ### Resend Reminder Email - C# Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Send reminder emails to recipients who have not yet signed a pending document. This is done by providing the document's GUID. ```csharp using RightSignature; IDocument doc = new DocumentApi(); // Resend reminder for a pending document string documentGuid = "Y9TLYJJ335DU5EXZLNBYG9"; string result = doc.ResendReminder(documentGuid); Console.WriteLine(result); ``` -------------------------------- ### SendDocument API Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Send a Document for Signature. This endpoint allows you to send a document for electronic signature by providing the document via URL or base64-encoded content. It returns XML with document details including the GUID. ```APIDOC ## SendDocument - Send a Document for Signature ### Description Send a document for electronic signature by providing the document via URL or base64-encoded content. Returns XML with document details including the GUID. ### Method POST ### Endpoint /documents ### Parameters #### Query Parameters - **type** (string) - Required - Specifies the document source type, either "url" or "base64". - **url** (string) - Required - The URL to fetch the document from, or the local file path if type is "base64". - **subject** (string) - Required - The email subject for the signature request. - **fileName** (string) - Required - The name of the file. - **recipients** (array) - Required - A list of recipients with their details (name, email, role, etc.). - **description** (string) - Optional - A description for the document. - **expires** (integer) - Optional - The expiration period in days (2, 5, 15, or 30). - **action** (string) - Optional - The action to perform, either "send" or "redirect". Defaults to "send". - **callback_location** (string) - Optional - A URL for receiving callback notifications. - **use_text_tags** (string) - Optional - Set to "true" to parse for text tags within the document. Defaults to "false". - **embedded_signing** (boolean) - Optional - If true, returns embedded signing links. Defaults to false. - **tags** (object) - Optional - Key-value pairs for tagging the document. ### Request Example ```json { "type": "url", "url": "https://example.com/contract.pdf", "subject": "Please sign the Service Agreement", "fileName": "service_agreement.pdf", "tags": { "project": "onboarding", "year": "2024" }, "recipients": [ { "name": "Sender Corp", "email": "sender@corp.com", "role": "Document Sender", "is_sender": true, "can_edit": true }, { "name": "Client Name", "email": "client@example.com", "role": "Signer", "is_sender": false, "can_edit": true } ], "description": "Service agreement for Q1 2024", "expires": 30, "action": "send", "callback_location": "https://myapp.com/callback", "use_text_tags": "false", "embedded_signing": false } ``` ### Response #### Success Response (200) - **document_guid** (string) - The unique identifier for the document. - **status** (string) - The current status of the document. #### Response Example ```xml Y9TLYJJ335DU5EXZLNBYG9 sent ... other document details ... ``` ``` -------------------------------- ### Initialize RightSignature API Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Initialize the API helper and instantiate the Document and Template API interfaces. ```csharp using RightSignature; // Initialize the API (required for OAuth authentication) ApiHelper.Initialize(); // Create instances of the Document and Template APIs IDocument documentApi = new DocumentApi(); ITemplate templateApi = new TemplateApi(); ``` -------------------------------- ### Send Template as Document with RightSignature C# Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Prepackages a template and sends it as a document with specified roles, merge fields, and tags. Set the action parameter to 'send' for immediate delivery or 'prefill' for redirect. ```csharp using RightSignature; using System.Collections.Generic; ITemplate templateApi = new TemplateApi(); // First, prepackage the template string templateGuid = "a_2915_20cd89c8ab494d5f9edb3c34dd05f1c2"; string prepackagedXml = templateApi.PrepackageTemplate(templateGuid); string prepackagedGuid = ApiHelper.getGuid(prepackagedXml, "template"); // Define roles (must match template's role names) List roles = new List(); roles.Add(new Structs.Recipient("John Smith", "john@example.com", "Signer", false, true)); roles.Add(new Structs.Recipient("Jane Doe", "jane@example.com", "Co-Signer", false, true)); // Define merge fields (must match template's merge field names) List mergeFields = new List(); mergeFields.Add(new Structs.MergeField("client_name", "Acme Corporation", true)); mergeFields.Add(new Structs.MergeField("contract_date", "2024-01-15", true)); mergeFields.Add(new Structs.MergeField("amount", "$50,000", false)); // Tags for the document Dictionary tags = new Dictionary(); tags.Add("contract_id", "CNT-2024-001"); // Send the template as a document string result = templateApi.PreFillORSendAsDocument( guid: prepackagedGuid, subject: "Employment Contract - John Smith", action: "send", // "send" or "prefill" roles: roles, mergeFields: mergeFields, tags: tags, expires_in: 15, // Days: 2, 5, 15, or 30 description: "Annual employment contract", callbackURL: "https://myapp.com/callback", embedded_signing: true // Return embedded signer links ); Console.WriteLine(result); // When embedded_signing is true, response includes signer-links with embedded URLs ``` -------------------------------- ### List All Templates Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Retrieves a list of templates, supporting optional search queries, pagination, and tag-based filtering. ```csharp using RightSignature; using System.Collections.Generic; ITemplate templateApi = new TemplateApi(); // Get all templates string templates = templateApi.GetTemplates(); Console.WriteLine(templates); // Get templates with filtering Dictionary tags = new Dictionary(); tags.Add("category", "contracts"); string filteredTemplates = templateApi.GetTemplates( query: "employment", // Search term page: 1, // Page number perPage: 20, // Results per page: 10, 20, 30, 40, or 50 tags: tags // Filter by tags ); Console.WriteLine(filteredTemplates); ``` -------------------------------- ### POST /templates/prefill-or-send Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Sends a prepackaged template as a document with prefilled roles and merge fields. Supports immediate sending or generating a prefill redirect. ```APIDOC ## POST /templates/prefill-or-send ### Description Sends a prepackaged template as a document. Requires a prepackaged template GUID. ### Method POST ### Parameters #### Request Body - **guid** (string) - Required - The prepackaged template GUID. - **subject** (string) - Required - The email subject for the document. - **action** (string) - Required - The action to perform: "send" or "prefill". - **roles** (List) - Optional - List of recipients matching template roles. - **mergeFields** (List) - Optional - List of merge fields to populate. - **tags** (Dictionary) - Optional - Key-value pairs for document tagging. - **expires_in** (int) - Optional - Expiration in days (2, 5, 15, or 30). - **description** (string) - Optional - Internal description of the document. - **callbackURL** (string) - Optional - URL for webhook notifications. - **embedded_signing** (bool) - Optional - If true, returns embedded signer links. ### Response #### Success Response (200) - **result** (string) - XML response containing document details and signer links if embedded_signing is true. ``` -------------------------------- ### Configure Authentication in App.config Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Set the authentication type and credentials in the application configuration file before initializing the API. ```xml ``` -------------------------------- ### List All Templates Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Retrieves a paginated list of templates, with options for filtering by search query and tags. ```APIDOC ## GetTemplates - List All Templates ### Description Retrieve a paginated list of templates with optional filtering by search query and tags. ### Method GET ### Endpoint `/templates` ### Parameters #### Query Parameters - **query** (string) - Optional - A search term to filter templates. - **page** (integer) - Optional - The page number for pagination. Defaults to 1. - **perPage** (integer) - Optional - The number of results per page. Allowed values: 10, 20, 30, 40, 50. Defaults to 10. - **tags** (object) - Optional - A dictionary of key-value pairs to filter templates by tags. - **key** (string) - The tag name. - **value** (string) - The tag value. ### Request Example (For filtered request) `/templates?query=employment&page=1&perPage=20&tags[category]=contracts` ### Response (The C# example returns a string, likely a JSON array of templates.) #### Success Response (200) - **templates** (array) - A list of template objects. ``` -------------------------------- ### Categorize Documents with Tags Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Use a dictionary to define name/value pair tags or simple tags for document organization. ```csharp using System.Collections.Generic; // Create tags dictionary for document organization Dictionary tags = new Dictionary(); // Add name/value pair tags tags.Add("department", "sales"); tags.Add("client_id", "12345"); tags.Add("contract_type", "nda"); // Simple tags use null for value tags.Add("urgent", null); ``` -------------------------------- ### Create Template Builder Token Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Generates a redirect token to allow users to build templates via the RightSignature interface. ```csharp using RightSignature; using System.Collections.Generic; ITemplate templateApi = new TemplateApi(); // Define acceptable role names (user must choose from these) List roleNames = new List { "Signer", "Co-Signer", "Witness" }; // Define acceptable merge field names List mergeFields = new List { "client_name", "contract_date", "amount" }; // Tags to apply to the created template Dictionary tags = new Dictionary(); tags.Add("type", "employment"); tags.Add("department", "hr"); // Build the template string result = templateApi.BuildTemplate( tags: tags, acceptableRoleNames: roleNames, acceptableMergeFieldNames: mergeFields, callback_location: "https://myapp.com/template-callback", redirect_location: "https://myapp.com/template-complete" ); Console.WriteLine(result); // Response contains a redirect_token to use with RightSignature's template builder ``` -------------------------------- ### Create a Template Builder Token Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Generates a redirect token to build a new template via the RightSignature interface. ```APIDOC ## BuildTemplate - Create a Template Builder Token ### Description Generate a redirect token that allows users to build a new template through the RightSignature interface. ### Method POST ### Endpoint `/template_builder/token` ### Parameters #### Request Body - **tags** (object) - Optional - Tags to apply to the created template. - **key** (string) - The tag name. - **value** (string) - The tag value. - **acceptableRoleNames** (array) - Optional - A list of acceptable role names for the template. - **roleName** (string) - A role name. - **acceptableMergeFieldNames** (array) - Optional - A list of acceptable merge field names for the template. - **fieldName** (string) - A merge field name. - **callback_location** (string) - Optional - The URL to redirect to after the template is built (callback). - **redirect_location** (string) - Optional - The URL to redirect to after the template is built (completion). ### Request Example ```json { "tags": { "type": "employment", "department": "hr" }, "acceptableRoleNames": ["Signer", "Co-Signer", "Witness"], "acceptableMergeFieldNames": ["client_name", "contract_date", "amount"], "callback_location": "https://myapp.com/template-callback", "redirect_location": "https://myapp.com/template-complete" } ``` ### Response (The C# example returns a string containing a redirect token.) #### Success Response (200) - **result** (string) - Contains a redirect_token to use with RightSignature's template builder. ``` -------------------------------- ### Send Document via URL - C# Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Use this method to send a document for signature by providing a URL. Ensure the URL points to a valid PDF document. The `expires` parameter accepts specific values: 2, 5, 15, or 30 days. ```csharp using RightSignature; using System.Collections.Generic; IDocument doc = new DocumentApi(); // Prepare recipients List recipients = new List(); recipients.Add(new Structs.Recipient("Sender Corp", "sender@corp.com", "Document Sender", true, true)); recipients.Add(new Structs.Recipient("Client Name", "client@example.com", "Signer", false, true)); // Prepare tags Dictionary tags = new Dictionary(); tags.Add("project", "onboarding"); tags.Add("year", "2024"); // Send document from URL string result = doc.SendDocument( type: "url", // "url" or "base64" url: "https://example.com/contract.pdf", // URL to fetch document from subject: "Please sign the Service Agreement", // Email subject fileName: "service_agreement.pdf", // Filename tags: tags, // Optional tags recipients: recipients, // Required recipients description: "Service agreement for Q1 2024", // Optional description expires: 30, // Expiration in days (2, 5, 15, or 30) action: "send", // "send" or "redirect" callback_location: "https://myapp.com/callback", // Optional callback URL use_text_tags: "false", // Parse for text tags embedded_signing: false // Return embedded signing links ); Console.WriteLine(result); ``` -------------------------------- ### List All Documents - C# Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Retrieve a paginated list of all documents. You can filter the results by document state, search query, recipient email, and tags. The `perPage` parameter accepts values: 10, 20, 30, 40, or 50. ```csharp using RightSignature; using System.Collections.Generic; IDocument doc = new DocumentApi(); // Get all documents (basic call) string allDocs = doc.GetDocuments(); Console.WriteLine(allDocs); // Get documents with filtering string filteredDocs = doc.GetDocuments( query: "service agreement", // Search term docStates: "pending,completed", // Filter by state: pending, completed, trash page: 1, // Page number (starts at 1) perPage: 20, // Results per page: 10, 20, 30, 40, or 50 recipientEmail: "client@example.com" // Filter by recipient ); Console.WriteLine(filteredDocs); // Get documents with tag filtering Dictionary searchTags = new Dictionary(); searchTags.Add("department", "sales"); searchTags.Add("year", "2024"); string taggedDocs = doc.GetDocuments( tags: searchTags, page: 1, perPage: 10 ); Console.WriteLine(taggedDocs); ``` -------------------------------- ### Update Document Tags Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Replaces all existing tags on a document with a new set of key-value pairs. ```csharp using RightSignature; using System.Collections.Generic; IDocument doc = new DocumentApi(); // Create new tags to replace existing ones Dictionary newTags = new Dictionary(); newTags.Add("status", "reviewed"); newTags.Add("priority", "high"); newTags.Add("client_id", "67890"); // Update tags on the document (replaces all existing tags) string documentGuid = "Y9TLYJJ335DU5EXZLNBYG9"; string result = doc.UpdateDocumentTags(documentGuid, newTags); Console.WriteLine(result); ``` -------------------------------- ### Create Document Recipients Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Define signers, CC recipients, and the sender using the Structs.Recipient class. ```csharp using RightSignature; using System.Collections.Generic; // Create a list of recipients for the document List recipients = new List(); // Add the sender (is_sender = true) recipients.Add(new Structs.Recipient( "Company Name", // name "sender@company.com", // email "Document Sender", // role true, // is_sender true // locked (cannot be modified) )); // Add a signer recipient recipients.Add(new Structs.Recipient( "John Smith", // name "john.smith@example.com", // email "Signer", // role (can be "signer" or "cc") false, // is_sender true // locked )); // Add a CC recipient recipients.Add(new Structs.Recipient( "Jane Doe", // name "jane.doe@example.com", // email "cc", // role false, // is_sender false // locked )); ``` -------------------------------- ### Update Document Tags Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Replaces all existing tags on a document with a new set of tags. ```APIDOC ## UpdateDocumentTags - Update Document Tags ### Description Replace all tags on a document with new tags. All existing tags are removed. ### Method PUT (Assumed, as it modifies a resource) ### Endpoint `/documents/{documentGuid}/tags` (Assumed structure) ### Parameters #### Path Parameters - **documentGuid** (string) - Required - The unique identifier of the document. #### Request Body - **tags** (object) - Required - A dictionary of key-value pairs representing the new tags to be applied. - **key** (string) - The tag name. - **value** (string) - The tag value. ### Request Example ```json { "status": "reviewed", "priority": "high", "client_id": "67890" } ``` ### Response (The C# example returns a string, likely a success message or status.) #### Success Response (200) - **result** (string) - A confirmation message or status of the operation. ``` -------------------------------- ### DeleteDocument API Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Move Document to Trash. This endpoint moves a document to the trash, making it unavailable for signature. ```APIDOC ## DeleteDocument - Move Document to Trash ### Description Move a document to trash. The document will no longer be available for signature. ### Method DELETE ### Endpoint /documents/{document_guid} ### Parameters #### Path Parameters - **document_guid** (string) - Required - The unique identifier (GUID) of the document to move to trash. ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the document was moved to trash. #### Response Example ```json { "message": "Document Y9TLYJJ335DU5EXZLNBYG9 moved to trash successfully." } ``` ``` -------------------------------- ### GetDocuments API Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt List All Documents. Retrieve a paginated list of documents with optional filtering by state, tags, search query, and recipient email. ```APIDOC ## GetDocuments - List All Documents ### Description Retrieve a paginated list of documents with optional filtering by state, tags, search query, and recipient email. ### Method GET ### Endpoint /documents ### Parameters #### Query Parameters - **query** (string) - Optional - A search term to filter documents. - **docStates** (string) - Optional - Comma-separated list of document states to filter by (e.g., "pending,completed,trash"). - **page** (integer) - Optional - The page number for pagination (starts at 1). - **perPage** (integer) - Optional - The number of results per page (10, 20, 30, 40, or 50). - **recipientEmail** (string) - Optional - Filter documents by a specific recipient's email address. - **tags** (object) - Optional - Key-value pairs for filtering documents by tags. ### Request Example ``` GET /documents?query=service%20agreement&docStates=pending,completed&page=1&perPage=20&recipientEmail=client@example.com ``` ### Response #### Success Response (200) - **documents** (array) - A list of document objects. - **guid** (string) - The unique identifier for the document. - **status** (string) - The current status of the document. - **subject** (string) - The subject of the document. - **created_at** (string) - Timestamp of document creation. #### Response Example ```json { "documents": [ { "guid": "Y9TLYJJ335DU5EXZLNBYG9", "status": "pending", "subject": "Service Agreement", "created_at": "2024-01-15T10:00:00Z" }, ... ] } ``` ``` -------------------------------- ### Extend Document Expiration Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Extends the expiration date of a document by 7 days. ```APIDOC ## ExtendExpiration - Extend Document Expiration ### Description Extend the expiration date of a document by 7 days. ### Method POST (Assumed, as it modifies a resource) ### Endpoint `/documents/{documentGuid}/extend_expiration` (Assumed structure) ### Parameters #### Path Parameters - **documentGuid** (string) - Required - The unique identifier of the document. ### Request Example (No explicit request body shown in the C# example, assuming it's handled by the SDK) ### Response (The C# example returns a string, likely a success message or status.) #### Success Response (200) - **result** (string) - A confirmation message or status of the operation. ``` -------------------------------- ### ResendReminder API Source: https://context7.com/rightsignature/rightsignature-api-csharp/llms.txt Send Reminder Emails. Resend reminder emails to recipients who haven't yet signed the document. ```APIDOC ## ResendReminder - Send Reminder Emails ### Description Resend reminder emails to recipients who haven't yet signed the document. ### Method POST ### Endpoint /documents/{document_guid}/reminders ### Parameters #### Path Parameters - **document_guid** (string) - Required - The unique identifier (GUID) of the document for which to resend reminders. ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating that reminder emails have been sent. #### Response Example ```json { "message": "Reminder emails sent for document Y9TLYJJ335DU5EXZLNBYG9." } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.