RMail API

Back to Envelope(v1)

POST api/V1/Envelope/CreateEnvelopeFromStatic

This will create a envelope using static link and return Envelope Id.

Prerequisites

To be implemented

Request Information

Lorem ipsum

URI Parameters

None

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

Name Description Type Additional information
TemplateCode integer None
RecipientEmail string None
RecipientName string None
IsSigningEmail boolean None
PostSigningUrl string None
IpAddress string None
TransDetails Collection of TemplateTransaction None

Request Formats

application/json, text/json
Sample:
{
"TemplateCode": 1,
"RecipientEmail": "sample string 2",
"RecipientName": "sample string 3",
"IsSigningEmail": true,
"PostSigningUrl": "sample string 5",
"IpAddress": "sample string 6",
"TransDetails": [
{
"ControlId": "f9dcd94c-04b7-4660-bb41-cac652994c33",
"ControlName": "sample string 2",
"ControlValue": "sample string 3",
"IsReadOnly": true
},
{
"ControlId": "f9dcd94c-04b7-4660-bb41-cac652994c33",
"ControlName": "sample string 2",
"ControlValue": "sample string 3",
"IsReadOnly": true
}
]
}
application/xml, text/xml
Sample:
<APIStaticTemplate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<TemplateCode>1</TemplateCode>
<RecipientEmail>sample string 2</RecipientEmail>
<RecipientName>sample string 3</RecipientName>
<IsSigningEmail>true</IsSigningEmail>
<PostSigningUrl>sample string 5</PostSigningUrl>
<IpAddress>sample string 6</IpAddress>
<TransDetails>
<TemplateTrasnaction>
<ControlId>f9dcd94c-04b7-4660-bb41-cac652994c33</ControlId>
<ControlName>sample string 2</ControlName>
<ControlValue>sample string 3</ControlValue>
<IsReadOnly>true</IsReadOnly>
</TemplateTrasnaction>
<TemplateTrasnaction>
<ControlId>f9dcd94c-04b7-4660-bb41-cac652994c33</ControlId>
<ControlName>sample string 2</ControlName>
<ControlValue>sample string 3</ControlValue>
<IsReadOnly>true</IsReadOnly>
</TemplateTrasnaction>
</TransDetails>
</APIStaticTemplate>

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
EnvelopeCode This will return Envelope Code. string None
SignDoumentUrl This will return Sign Document Url. string None
RecipientList Collection of APIRecipientList None
application/json, text/json
Sample:
{
"StatusCode": 100,
"StatusMessage": "sample string 1",
"Message": "sample string 2",
"EnvelopeId": "4b1ed14f-d1d9-4b1d-ad6b-0488abf8b1b8",
"EnvelopeCode": "sample string 4",
"SignDoumentUrl": "sample string 5",
"RecipientList": [
{
"RecipientName": "sample string 1",
"RecipientEmail": "sample string 2",
"Order": 1,
"Type": "sample string 3",
"SigningUrl": "sample string 4"
},
{
"RecipientName": "sample string 1",
"RecipientEmail": "sample string 2",
"Order": 1,
"Type": "sample string 3",
"SigningUrl": "sample string 4"
}
]
}
application/xml, text/xml
Sample:
<ResponseMessageForEnvelope 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>4b1ed14f-d1d9-4b1d-ad6b-0488abf8b1b8</EnvelopeId>
    <EnvelopeCode>sample string 4</EnvelopeCode>
    <SignDoumentUrl>sample string 5</SignDoumentUrl>
    <RecipientList>
    <APIRecipientList>
        <RecipientName>sample string 1</RecipientName>
        <RecipientEmail>sample string 2</RecipientEmail>
        <Order>1</Order>
        <Type>sample string 3</Type>
        <SigningUrl>sample string 4</SigningUrl>
    </APIRecipientList>
    <APIRecipientList>
        <RecipientName>sample string 1</RecipientName>
        <RecipientEmail>sample string 2</RecipientEmail>
        <Order>1</Order>
        <Type>sample string 3</Type>
        <SigningUrl>sample string 4</SigningUrl>
    </APIRecipientList>
    </RecipientList>
</ResponseMessageForEnvelope>

Was this page helpful?