Share envelope with other users

POST

/v2.1/accounts/:accountId/envelopes/:envelopeId/shares

POST

/restapi/v2.1/accounts/:accountId/envelopes/:envelopeId/shares

curl -X POST https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/envelopes/ENVELOPE_ID/shares \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "shares": [
    {
      "agentUser": {
        "accountId": "sample string 1",
        "email": "sample string 2",
        "name": "sample string 3",
        "userId": "sample string 4"
      },
      "customMessage": "sample string 1",
      "permission": "sample string 2",
      "shareId": "sample string 3"
    }
  ]
}'

{
  "shares": [
    {
      "agentUser": {
        "accountId": "sample string 1",
        "email": "sample string 2",
        "name": "sample string 3",
        "userId": "sample string 4"
      },
      "createdTimestamp": "sample string 1",
      "envelopeId": "sample string 2",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "modifiedTimestamp": "sample string 3",
      "permission": "sample string 4",
      "shareId": "sample string 5",
      "subject": "sample string 6"
    }
  ]
}

Shares an envelope with other users in your account. Each shares object in the request array represents one user with whom the envelope will be shared.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

The external account number (int) or account ID GUID of the account to which the caller and the users to whom the envelope will be shared all belong.

envelopeIdstringRequired

The envelope ID GUID of the envelope being shared.

Request

This endpoint expects an object: envelopesSharesRequest

shareslist of objectsOptional

An array of objects that contain information on the accounts to whom the envelope will be shared. Each object in the array holds the information for one account. Required.

Response

Successful response.

shareslist of objectsOptional

Errors

400

Bad Request Error