Back to Envelope(v1) This will delete existing recipient from Envelope
To be implemented
Lorem ipsum
None
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.
| Name | Description | Type | Additional information |
|---|---|---|---|
| EnvelopeID | Get/Set envelope id for which recipient to add. | GUID | None |
| RecipientType | Get/Set type for which recipient to add. More info from Master API. | GUID | None |
| RecipientName | Get/Set name for which recipient to add. | string | None |
| Get/Set email address for which recipient to add. | string | Data type: EmailAddress | |
| Order | Get/Set order for which recipient to add. | integer | None |
| RecipientID | Get/Set ID for which recipient to add. To add recipient new ID to be provided and to update same ID needs to be provided. New ID can be taken from – https://www.guidgenerator.com/ | GUID | None |
Sample:
{
"EnvelopeID": "2d6db866-088d-4ed3-86a9-5740d1cc029e",
"RecipientType": "00000000-0000-0000-0000-000000000000",
"RecipientName": "sample string 3",
"Email": "sample string 4",
"Order": 5,
"RecipientID": "00000000-0000-0000-0000-000000000000"
}Sample:
<APIRecipient xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<EnvelopeID>2d6db866-088d-4ed3-86a9-5740d1cc029e</EnvelopeID>
<RecipientType>00000000-0000-0000-0000-000000000000</RecipientType>
<RecipientName>sample string 3</RecipientName>
<Email>sample string 4</Email>
<Order>5</Order>
<RecipientID>00000000-0000-0000-0000-000000000000</RecipientID>
</APIRecipient>| 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 |
| RecipientID | This will return Recipient ID. | GUID | None |
| RecipientName | This will return Recipient Name | string | None |
| SignerCount | integer |
None |
Sample:
{
"StatusCode": 100,
"StatusMessage": "sample string 1",
"Message": "sample string 2",
"EnvelopeID": "3694a75f-2560-4ccb-b39c-b863913a8026",
"RecipientID": "e8908267-44a6-4728-869a-86338be7e6aa",
"RecipientName": "sample string 5",
"SignerCount": 1
}Sample:
<RecipientResponse 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>3694a75f-2560-4ccb-b39c-b863913a8026</EnvelopeID>
<RecipientID>e8908267-44a6-4728-869a-86338be7e6aa</RecipientID>
<RecipientName>sample string 5</RecipientName>
<SignerCount>1</SignerCount>
</RecipientResponse>