RMail API

Back to Envelope(v1)

POST api/V1/Envelope/SendEnvelope

This will send envelope to signer for mentioned Envelope Id.

Prerequisites

None

Steps to follow-:

1. Initialize Envelope – using following url

2. Upload Local Document – using following url

3. Delete Document [Optional] – using following url

4. Prepare Envelope – using following url

5. Add Signature Control [Optional] – using following url

6. Delete Control [Optional] – using following url

7. Clear Controls [Optional] – using following url

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
EnvelopeID This will set Envelope Id. GUID None
UserId This will set UserId. globally unique identifier
 None
EnvelopeTypeId Get/Set Envelope Type Id globally unique identifier
 None
Stage Get/Set Envelope Stages string None
UserToken This will set userToken. string None
EnvelopeDCode This will set Envelope display code. string None
IpAddress
 This will set IPAddress. string None
SigningMethod integer None
Controls Get/Set list of envelopes to add in envelope Collection of DocumentContentPOCO None

Request Formats

application/json, text/json
Sample:
{
"EnvelopeID": "00000000-0000-0000-0000-000000000000",
"UserId": "9a287adb-711b-455e-87ca-9b71fec59f33",
"EnvelopeTypeId": "6b9193a2-a582-45ca-b503-aca86247f37a",
"Stage": "sample string 4",
"UserToken": "sample string 5",
"EnvelopeDCode": "sample string 6",
"IpAddress": "sample string 7",
"SigningMethod": 1,
"Controls": [
{
  "ID": "279891f2-e1ec-487d-bd2e-9440173778fa",
  "ControlID": "a2367f12-c835-4d9a-9248-62b728ec912a",
  "DocumentID": "b0ea42e4-d5a1-469b-8d79-e0297d770d56",
  "RecipientID": "3fa2e541-6f2a-4280-9ecf-7cff77dd4a07",
  "ControlHtmlID": "sample string 5",
  "Required": true,
  "DocumentPageNumber": 7,
  "PageNumber": 8,
  "XCoordinate": 9,
  "YCoordinate": 10,
  "ZCoordinate": 11,
  "ControlValue": "sample string 12",
  "Label": "sample string 13",
  "Height": 14,
  "Width": 15,
  "GroupName": "sample string 16",
  "ControlHtmlData": "sample string 17",
  "RecipientName": "sample string 18",
  "IsControlDeleted": true,
  "ControlType": "7cf13b73-375a-4756-b2d3-b92a0659c69f",
  "Left": 21.1,
  "Top": 22.1,
  "SenderControlValue": "sample string 23",
  "MappedTemplateControlID": "f5c717e5-f0ff-4f8b-9e2e-51185b689936",
  "ControlStyle": {
    "FontID": "91ec7939-c175-424d-a325-8964d2b6a76c",
    "FontSize": 2,
    "FontColor": "sample string 3",
    "IsBold": true,
    "IsUnderline": true,
    "IsItalic": true
  },
  "Options": [
    {
      "ID": "3a7e4dd1-c2a3-42b0-9e50-8cd463e41fc8",
      "Order": 2,
      "OptionText": "sample string 3"
    },
    {
      "ID": "3a7e4dd1-c2a3-42b0-9e50-8cd463e41fc8",
      "Order": 2,
      "OptionText": "sample string 3"
    }
  ],
  "Dependencies": [
    {
      "ControlID": "f0402ae0-1288-4883-ba56-d3277495e8f1",
      "ControlParentID": "caf97492-a8bc-4837-b865-8c40ac1c909b",
      "ConditionID": "01eab077-10ad-42be-b00c-bdb30e5dd7a2",
      "ConditionText": "sample string 4",
      "GroupCode": 5
    },
    {
      "ControlID": "f0402ae0-1288-4883-ba56-d3277495e8f1",
      "ControlParentID": "caf97492-a8bc-4837-b865-8c40ac1c909b",
      "ConditionID": "01eab077-10ad-42be-b00c-bdb30e5dd7a2",
      "ConditionText": "sample string 4",
      "GroupCode": 5
    }
  ],
  "ParentHeight": 24,
  "ImageOriginalHeight": 25,
  "ImageHeight": 26,
  "ImageOriginalWidth": 27,
  "ImageWidth": 28,
  "SignatureControlValue": 64,
  "ControlOptions": [
    {
      "OptionText": "sample string 1"
    },
    {
      "OptionText": "sample string 1"
    }
  ]
},
{
  "ID": "279891f2-e1ec-487d-bd2e-9440173778fa",
  "ControlID": "a2367f12-c835-4d9a-9248-62b728ec912a",
  "DocumentID": "b0ea42e4-d5a1-469b-8d79-e0297d770d56",
  "RecipientID": "3fa2e541-6f2a-4280-9ecf-7cff77dd4a07",
  "ControlHtmlID": "sample string 5",
  "Required": true,
  "DocumentPageNumber": 7,
  "PageNumber": 8,
  "XCoordinate": 9,
  "YCoordinate": 10,
  "ZCoordinate": 11,
  "ControlValue": "sample string 12",
  "Label": "sample string 13",
  "Height": 14,
  "Width": 15,
  "GroupName": "sample string 16",
  "ControlHtmlData": "sample string 17",
  "RecipientName": "sample string 18",
  "IsControlDeleted": true,
  "ControlType": "7cf13b73-375a-4756-b2d3-b92a0659c69f",
  "Left": 21.1,
  "Top": 22.1,
  "SenderControlValue": "sample string 23",
  "MappedTemplateControlID": "f5c717e5-f0ff-4f8b-9e2e-51185b689936",
  "ControlStyle": {
    "FontID": "91ec7939-c175-424d-a325-8964d2b6a76c",
    "FontSize": 2,
    "FontColor": "sample string 3",
    "IsBold": true,
    "IsUnderline": true,
    "IsItalic": true
  },
  "Options": [
    {
      "ID": "3a7e4dd1-c2a3-42b0-9e50-8cd463e41fc8",
      "Order": 2,
      "OptionText": "sample string 3"
    },
    {
      "ID": "3a7e4dd1-c2a3-42b0-9e50-8cd463e41fc8",
      "Order": 2,
      "OptionText": "sample string 3"
    }
  ],
  "Dependencies": [
    {
      "ControlID": "f0402ae0-1288-4883-ba56-d3277495e8f1",
      "ControlParentID": "caf97492-a8bc-4837-b865-8c40ac1c909b",
      "ConditionID": "01eab077-10ad-42be-b00c-bdb30e5dd7a2",
      "ConditionText": "sample string 4",
      "GroupCode": 5
    },
    {
      "ControlID": "f0402ae0-1288-4883-ba56-d3277495e8f1",
      "ControlParentID": "caf97492-a8bc-4837-b865-8c40ac1c909b",
      "ConditionID": "01eab077-10ad-42be-b00c-bdb30e5dd7a2",
      "ConditionText": "sample string 4",
      "GroupCode": 5
    }
  ],
  "ParentHeight": 24,
  "ImageOriginalHeight": 25,
  "ImageHeight": 26,
  "ImageOriginalWidth": 27,
  "ImageWidth": 28,
  "SignatureControlValue": 64,
  "ControlOptions": [
    {
      "OptionText": "sample string 1"
    },
    {
      "OptionText": "sample string 1"
    }
  ]
}
]
}
application/xml, text/xml
Sample:
<EnvelopeControls xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<EnvelopeID>00000000-0000-0000-0000-000000000000</EnvelopeID>
<UserId>9a287adb-711b-455e-87ca-9b71fec59f33</UserId>
<EnvelopeTypeId>6b9193a2-a582-45ca-b503-aca86247f37a</EnvelopeTypeId>
<Stage>sample string 4</Stage>
<UserToken>sample string 5</UserToken>
<EnvelopeDCode>sample string 6</EnvelopeDCode>
<IpAddress>sample string 7</IpAddress>
<SigningMethod>1</SigningMethod>
<Controls>
<DocumentContentPOCO>
  <ID>279891f2-e1ec-487d-bd2e-9440173778fa</ID>
  <ControlID>a2367f12-c835-4d9a-9248-62b728ec912a</ControlID>
  <DocumentID>b0ea42e4-d5a1-469b-8d79-e0297d770d56</DocumentID>
  <RecipientID>3fa2e541-6f2a-4280-9ecf-7cff77dd4a07</RecipientID>
  <ControlHtmlID>sample string 5</ControlHtmlID>
  <Required>true</Required>
  <DocumentPageNumber>7</DocumentPageNumber>
  <PageNumber>8</PageNumber>
  <XCoordinate>9</XCoordinate>
  <YCoordinate>10</YCoordinate>
  <ZCoordinate>11</ZCoordinate>
  <ControlValue>sample string 12</ControlValue>
  <Label>sample string 13</Label>
  <Height>14</Height>
  <Width>15</Width>
  <GroupName>sample string 16</GroupName>
  <ControlHtmlData>sample string 17</ControlHtmlData>
  <RecipientName>sample string 18</RecipientName>
  <IsControlDeleted>true</IsControlDeleted>
  <ControlType>7cf13b73-375a-4756-b2d3-b92a0659c69f</ControlType>
  <Left>21.1</Left>
  <Top>22.1</Top>
  <SenderControlValue>sample string 23</SenderControlValue>
  <MappedTemplateControlID>f5c717e5-f0ff-4f8b-9e2e-51185b689936</MappedTemplateControlID>
  <ControlStyle>
    <FontID>91ec7939-c175-424d-a325-8964d2b6a76c</FontID>
    <FontSize>2</FontSize>
    <FontColor>sample string 3</FontColor>
    <IsBold>true</IsBold>
    <IsUnderline>true</IsUnderline>
    <IsItalic>true</IsItalic>
  </ControlStyle>
  <Options>
    <ControlOptionsPOCO>
      <ID>3a7e4dd1-c2a3-42b0-9e50-8cd463e41fc8</ID>
      <Order>2</Order>
      <OptionText>sample string 3</OptionText>
    </ControlOptionsPOCO>
    <ControlOptionsPOCO>
      <ID>3a7e4dd1-c2a3-42b0-9e50-8cd463e41fc8</ID>
      <Order>2</Order>
      <OptionText>sample string 3</OptionText>
    </ControlOptionsPOCO>
  </Options>
  <Dependencies>
    <ControlDependencyPOCO>
      <ControlID>f0402ae0-1288-4883-ba56-d3277495e8f1</ControlID>
      <ControlParentID>caf97492-a8bc-4837-b865-8c40ac1c909b</ControlParentID>
      <ConditionID>01eab077-10ad-42be-b00c-bdb30e5dd7a2</ConditionID>
      <ConditionText>sample string 4</ConditionText>
      <GroupCode>5</GroupCode>
    </ControlDependencyPOCO>
    <ControlDependencyPOCO>
      <ControlID>f0402ae0-1288-4883-ba56-d3277495e8f1</ControlID>
      <ControlParentID>caf97492-a8bc-4837-b865-8c40ac1c909b</ControlParentID>
      <ConditionID>01eab077-10ad-42be-b00c-bdb30e5dd7a2</ConditionID>
      <ConditionText>sample string 4</ConditionText>
      <GroupCode>5</GroupCode>
    </ControlDependencyPOCO>
  </Dependencies>
  <ParentHeight>24</ParentHeight>
  <ImageOriginalHeight>25</ImageOriginalHeight>
  <ImageHeight>26</ImageHeight>
  <ImageOriginalWidth>27</ImageOriginalWidth>
  <ImageWidth>28</ImageWidth>
  <SignatureControlValue>64</SignatureControlValue>
  <ControlOptions>
    <SelectOption>
      <OptionText>sample string 1</OptionText>
    </SelectOption>
    <SelectOption>
      <OptionText>sample string 1</OptionText>
    </SelectOption>
  </ControlOptions>
</DocumentContentPOCO>
<DocumentContentPOCO>
  <ID>279891f2-e1ec-487d-bd2e-9440173778fa</ID>
  <ControlID>a2367f12-c835-4d9a-9248-62b728ec912a</ControlID>
  <DocumentID>b0ea42e4-d5a1-469b-8d79-e0297d770d56</DocumentID>
  <RecipientID>3fa2e541-6f2a-4280-9ecf-7cff77dd4a07</RecipientID>
  <ControlHtmlID>sample string 5</ControlHtmlID>
  <Required>true</Required>
  <DocumentPageNumber>7</DocumentPageNumber>
  <PageNumber>8</PageNumber>
  <XCoordinate>9</XCoordinate>
  <YCoordinate>10</YCoordinate>
  <ZCoordinate>11</ZCoordinate>
  <ControlValue>sample string 12</ControlValue>
  <Label>sample string 13</Label>
  <Height>14</Height>
  <Width>15</Width>
  <GroupName>sample string 16</GroupName>
  <ControlHtmlData>sample string 17</ControlHtmlData>
  <RecipientName>sample string 18</RecipientName>
  <IsControlDeleted>true</IsControlDeleted>
  <ControlType>7cf13b73-375a-4756-b2d3-b92a0659c69f</ControlType>
  <Left>21.1</Left>
  <Top>22.1</Top>
  <SenderControlValue>sample string 23</SenderControlValue>
  <MappedTemplateControlID>f5c717e5-f0ff-4f8b-9e2e-51185b689936</MappedTemplateControlID>
  <ControlStyle>
    <FontID>91ec7939-c175-424d-a325-8964d2b6a76c</FontID>
    <FontSize>2</FontSize>
    <FontColor>sample string 3</FontColor>
    <IsBold>true</IsBold>
    <IsUnderline>true</IsUnderline>
    <IsItalic>true</IsItalic>
  </ControlStyle>
  <Options>
    <ControlOptionsPOCO>
      <ID>3a7e4dd1-c2a3-42b0-9e50-8cd463e41fc8</ID>
      <Order>2</Order>
      <OptionText>sample string 3</OptionText>
    </ControlOptionsPOCO>
    <ControlOptionsPOCO>
      <ID>3a7e4dd1-c2a3-42b0-9e50-8cd463e41fc8</ID>
      <Order>2</Order>
      <OptionText>sample string 3</OptionText>
    </ControlOptionsPOCO>
  </Options>
  <Dependencies>
    <ControlDependencyPOCO>
      <ControlID>f0402ae0-1288-4883-ba56-d3277495e8f1</ControlID>
      <ControlParentID>caf97492-a8bc-4837-b865-8c40ac1c909b</ControlParentID>
      <ConditionID>01eab077-10ad-42be-b00c-bdb30e5dd7a2</ConditionID>
      <ConditionText>sample string 4</ConditionText>
      <GroupCode>5</GroupCode>
    </ControlDependencyPOCO>
    <ControlDependencyPOCO>
      <ControlID>f0402ae0-1288-4883-ba56-d3277495e8f1</ControlID>
      <ControlParentID>caf97492-a8bc-4837-b865-8c40ac1c909b</ControlParentID>
      <ConditionID>01eab077-10ad-42be-b00c-bdb30e5dd7a2</ConditionID>
      <ConditionText>sample string 4</ConditionText>
      <GroupCode>5</GroupCode>
    </ControlDependencyPOCO>
  </Dependencies>
  <ParentHeight>24</ParentHeight>
  <ImageOriginalHeight>25</ImageOriginalHeight>
  <ImageHeight>26</ImageHeight>
  <ImageOriginalWidth>27</ImageOriginalWidth>
  <ImageWidth>28</ImageWidth>
  <SignatureControlValue>64</SignatureControlValue>
  <ControlOptions>
    <SelectOption>
      <OptionText>sample string 1</OptionText>
    </SelectOption>
    <SelectOption>
      <OptionText>sample string 1</OptionText>
    </SelectOption>
  </ControlOptions>
</DocumentContentPOCO>
</Controls>
</EnvelopeControls>

Response Information

Resource Description

Name Description Type
EnvelopeCode This will return envelope display code. string
TransparencyChangedMessage This will return message for transparency document. string
LanguageBasedApiMessge string
PrefillRecipientId string
StatusCode
 This will return Status Code. HttpStatusCode
StatusMessage
 This will return Status Message. string
StatusMessage
 This will return response message for corresponding status code. string
EnvelopeId This will return Envelope Id. GUID
SignDoumentUrl This will return Sign Document Url. string
RecipientList Collection of APIRecipientList

Response Formats

application/json, text/json
Sample:
{
"EnvelopeCode": "sample string 1",
"TransparencyChangedMessage": "sample string 2",
"LanguageBasedApiMessge": "sample string 3",
"PrefillRecipientId": "sample string 4",
"StatusCode": 100,
"StatusMessage": "sample string 5",
"Message": "sample string 6",
"EnvelopeId": "cc29a7a8-fd21-4e39-adf3-9de3ebbba649",
"SignDoumentUrl": "sample string 8",
"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:
<ResponseMessageForSendEnvelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StatusCode>Continue</StatusCode>
  <StatusMessage>sample string 5</StatusMessage>
  <Message>sample string 6</Message>
  <EnvelopeId>cc29a7a8-fd21-4e39-adf3-9de3ebbba649</EnvelopeId>
  <EnvelopeCode>sample string 1</EnvelopeCode>
  <SignDoumentUrl>sample string 8</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>
  <TransparencyChangedMessage>sample string 2</TransparencyChangedMessage>
  <LanguageBasedApiMessge>sample string 3</LanguageBasedApiMessge>
  <PrefillRecipientId>sample string 4</PrefillRecipientId>
</ResponseMessageForSendEnvelope>

Was this page helpful?

Yes No

About Us

Features

Related Websites

Success Stories

Customer Videos

Insights

More Insights

Industries

Pricing

Apps

Support

Sitemap

Training Videos

© 1999-2024 RPost. All Rights Reserved. Terms & Conditions, RMail | Gmail App Compliance.
RPost Patented (click for patent list).