POST api/DocusignEvent/Sendrecipientevent

Send to an approval flow any recipient envelope from Docusign

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
EnvelopeID		string	None.
RecipientStatuses		Collection of RecipientStatus	None.

Request Formats

application/json, text/json

Sample:

{
  "envelopeID": "sample string 1",
  "recipientStatuses": [
    {
      "type": "sample string 1",
      "email": "sample string 2",
      "userName": "sample string 3",
      "routingOrder": 4,
      "sent": "2026-05-08T20:19:21.0177604+02:00",
      "delivered": "2026-05-08T20:19:21.0177604+02:00",
      "signed": "2026-05-08T20:19:21.0177604+02:00",
      "declined": "2026-05-08T20:19:21.0177604+02:00",
      "declineReason": "sample string 6",
      "autoRespondedReason": "sample string 7",
      "status": "sample string 8",
      "recipientIPAddress": "sample string 9",
      "clientUserId": "sample string 10"
    },
    {
      "type": "sample string 1",
      "email": "sample string 2",
      "userName": "sample string 3",
      "routingOrder": 4,
      "sent": "2026-05-08T20:19:21.0177604+02:00",
      "delivered": "2026-05-08T20:19:21.0177604+02:00",
      "signed": "2026-05-08T20:19:21.0177604+02:00",
      "declined": "2026-05-08T20:19:21.0177604+02:00",
      "declineReason": "sample string 6",
      "autoRespondedReason": "sample string 7",
      "status": "sample string 8",
      "recipientIPAddress": "sample string 9",
      "clientUserId": "sample string 10"
    }
  ]
}

text/html

Sample:

{"envelopeID":"sample string 1","recipientStatuses":[{"type":"sample string 1","email":"sample string 2","userName":"sample string 3","routingOrder":4,"sent":"2026-05-08T20:19:21.0177604+02:00","delivered":"2026-05-08T20:19:21.0177604+02:00","signed":"2026-05-08T20:19:21.0177604+02:00","declined":"2026-05-08T20:19:21.0177604+02:00","declineReason":"sample string 6","autoRespondedReason":"sample string 7","status":"sample string 8","recipientIPAddress":"sample string 9","clientUserId":"sample string 10"},{"type":"sample string 1","email":"sample string 2","userName":"sample string 3","routingOrder":4,"sent":"2026-05-08T20:19:21.0177604+02:00","delivered":"2026-05-08T20:19:21.0177604+02:00","signed":"2026-05-08T20:19:21.0177604+02:00","declined":"2026-05-08T20:19:21.0177604+02:00","declineReason":"sample string 6","autoRespondedReason":"sample string 7","status":"sample string 8","recipientIPAddress":"sample string 9","clientUserId":"sample string 10"}]}

application/xml, text/xml

Sample:

<DocusignRecipientEventDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.ApprovalFlowModule.Application.Dtos.Dtos.DocusignEventAgg">
  <EnvelopeID>sample string 1</EnvelopeID>
  <RecipientStatuses>
    <RecipientStatus>
      <AutoRespondedReason>sample string 7</AutoRespondedReason>
      <ClientUserId>sample string 10</ClientUserId>
      <DeclineReason>sample string 6</DeclineReason>
      <Declined>2026-05-08T20:19:21.0177604+02:00</Declined>
      <Delivered>2026-05-08T20:19:21.0177604+02:00</Delivered>
      <Email>sample string 2</Email>
      <RecipientIPAddress>sample string 9</RecipientIPAddress>
      <RoutingOrder>4</RoutingOrder>
      <Sent>2026-05-08T20:19:21.0177604+02:00</Sent>
      <Signed>2026-05-08T20:19:21.0177604+02:00</Signed>
      <Status>sample string 8</Status>
      <Type>sample string 1</Type>
      <UserName>sample string 3</UserName>
    </RecipientStatus>
    <RecipientStatus>
      <AutoRespondedReason>sample string 7</AutoRespondedReason>
      <ClientUserId>sample string 10</ClientUserId>
      <DeclineReason>sample string 6</DeclineReason>
      <Declined>2026-05-08T20:19:21.0177604+02:00</Declined>
      <Delivered>2026-05-08T20:19:21.0177604+02:00</Delivered>
      <Email>sample string 2</Email>
      <RecipientIPAddress>sample string 9</RecipientIPAddress>
      <RoutingOrder>4</RoutingOrder>
      <Sent>2026-05-08T20:19:21.0177604+02:00</Sent>
      <Signed>2026-05-08T20:19:21.0177604+02:00</Signed>
      <Status>sample string 8</Status>
      <Type>sample string 1</Type>
      <UserName>sample string 3</UserName>
    </RecipientStatus>
  </RecipientStatuses>
</DocusignRecipientEventDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiDataResultOfDocusignRecipientEventDto

Name	Type	Additional information
Data	DocusignRecipientEventDto	None.
Success	boolean	None.
Message	string	None.
Errors	Collection of CustomError	None.
Warnings	Collection of string	None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.