Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
Authorizations

Creates a user 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.
post/v2.1/accounts/{accountId}/users/{userId}/authorization

Path parameters

accountIdstring required

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

userIdstring required

The ID of the principal user.

Request body

endDatestring

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

permissionstring

The permission level to grant the agent. Valid values:

  • Send
  • Manage
  • Sign
  • Edit

This property is required.

startDatestring

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

taskSourcestring
taskTypestring

Response

Successful response.