RMail API

Back to Template

DELETE api/V1/Template/DeleteDocument/{templateId}/{documentId}

This will delete document from mentioned Envelope Id or Template Id.

Prerequisites

To be implemented

Request Information

Lorem ipsum

URI Parameters

Name Description Type Additional information
templateId This is either an Envelope Id or Template Id. GUID Required
documentId This is a Document Id. GUID Required

Header Parameters

Header Description

Name Description Type
Content-Type This is a request content type application/json
Accept This is a response content type application/json
AuthToken This is user’s authorization token. example@example.com^296f1f85-35d4-4dd4-a350-67131c926546^rps^en-US

Note: From the Header parameters mentioned, “AuthToken” is not required for the below mentioned services.

  • Account/RegisterUser
  • Authentication/AuthenticateUser

Body Parameters

None.

Response Information

Resource Description

Name Description Type ADDITIONAL INFORMATION
StatusCode This will return Status Code. HttpStatusCode None
StatusMessage This will return Status Message. string None
Message This will return response message for corresponding status code. string None
EnvelopeId This will return Envelope Id. GUID None
DocumentCount This will return Total Documents for Envelope. integer None

Response Formats

application/json, text/json
Sample:
{
"StatusCode": 100,
"StatusMessage": "sample string 1",
"Message": "sample string 2",
"EnvelopeId": "00000000-0000-0000-0000-000000000000",
"DocumentCount": 4
}
application/xml, text/xml
Sample:
<ResponseMessageDocumentOnly xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<StatusCode>Continue</StatusCode>
<StatusMessage>sample string 1</StatusMessage>
<Message>sample string 2</Message>
<EnvelopeId>00000000-0000-0000-0000-000000000000</EnvelopeId>
<DocumentCount>4</DocumentCount>
</ResponseMessageDocumentOnly>

Was this page helpful?