Update envelope share

PUT

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

PUT

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

curl -X PUT https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/envelopes/ENVELOPE_ID/shares/SHARE_ID \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "customMessage": "sample string 1",
  "permission": "sample string 2"
}'

{
  "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"
}

Updates the specified envelope sharing request with the provided values.

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.

envelopeIdstringRequired

The envelopeId Guid of the envelope being accessed.

shareIdstringRequired

The ID of the envelope share request to be updated.

Request

This endpoint expects an object: envelopesSharePermissionRequest

customMessagestringOptional

permissionstringOptional

Response

Successful response.

agentUserobjectOptional

createdTimestampstringOptional

envelopeIdstringOptional

The envelope ID of the envelope status that failed to post.

errorDetailsobjectOptional

This object describes errors that occur. It is only valid for responses, and ignored in requests.

modifiedTimestampstringOptional

permissionstringOptional

senderInfoobjectOptional

shareIdstringOptional

subjectstringOptional

Errors

400

Bad Request Error