Authorizations

Creates a user authorization

POST
/v2.1/accounts/{accountId}/users/{userId}/authorization

Creates an authorization allowing one user to send and/or manage envelopes on behalf of another user.

The agent user acts on behalf of the principal user. The principal user is specified by the userId path parameter. The agent user is specified in the request body. Each principal user can only share signing permission with one agent user.

Specify in the request the level of access to share with the agent user. If you share signing access, the agent user will receive an email notification.

To call this endpoint:

  • You must be an account administrator or you must be the principal user.
  • The agent user and principal user must belong to the same account.
  • At least one of the following account settings must be enabled: AllowDelegatedSigning, AllowManagingEnvelopesOnBehalfOfOthers, AllowEditingEnvelopesOnBehalfOfOthers, AllowSendingEnvelopesOnBehalfOfOthers. These settings correspond to the level of access you can set for the authorization.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

userId*string

The ID of the principal user.

Request Body

application/json

The request object to create a user authorization.

agentUser?
endDate?string

The UTC DateTime to end the authorization. The default value is the max UTC value (9999-12-31T23:59:59.0000000+00:00).

permission?string

The permission level to grant the agent. Valid values:

  • Send
  • Manage
  • Sign
  • Edit

This property is required.

startDate?string

The UTC DateTime to initiate the authorization. The default value is the current date and time.

taskSource?string
taskType?string

Response Body

application/json

application/json

curl -X POST "https://example.com/v2.1/accounts/string/users/string/authorization" \  -H "Content-Type: application/json" \  -d '{}'
{  "agentUser": {    "accountId": "string",    "email": "string",    "name": "string",    "userId": "string"  },  "authorizationId": "string",  "created": "string",  "createdBy": "string",  "endDate": "string",  "modified": "string",  "modifiedBy": "string",  "permission": "string",  "principalUser": {    "accountId": "string",    "email": "string",    "name": "string",    "userId": "string"  },  "startDate": "string",  "taskSource": "string",  "taskType": "string"}

Updates sender fields for an envelope PUT

This method dynamically generates an envelope's documents by populating its sender fields. The envelope must be in a draft state. Use the [DocumentGeneration::getEnvelopeDocGenFormFields](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/documentgeneration/getenvelopedocgenformfields/) response to retrieve the list of sender fields for your envelope. Use that list to build the request for this method. For each field, specify the field name and the value to populate. For example, your request body might look like this: ```json { "docGenFormFields": [ { "documentId": "bf3202e1-xxxx-xxxx-xxxx-af4f41366879", "docGenFormFieldList": [ { "name": "Candidate_Name", "value": "Peggy Olson" }, { "name": "Job_Title", "value": "Technical Writer" }, { "name": "Manager_Name", "value": "Donald Draper" }, { "name": "Start_Date", "value": "1960-02-28" }, { "name": "Salary", "value": "3380" } ] } ] } ``` ### Important notes * If `update_docgen_formfields_only` is false (the default), the `documentId` changes after the update. * This endpoint does not validate number, date, or select data field values. The request can succeed even if a number or date field value is not a valid number or date, or if a select field value is not one of the allowed values. ### Related topics - [Learn about document generation in the eSignature concepts guide.](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/documents/document-generation/) - [See this method in use in your preferred coding language](https://developers.docusign.com/docs/esign-rest-api/how-to/request-signature-email-document-generation/).

Returns the user authorization for a given authorization ID GET

Returns the details for the user authorization specified by the `authorizationId`. To call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.