DOdocusign
Authorizations

Updates the start or end date for a user authorization.

Changed on

Updates the start and/or end date for a given user authorization. Specify the user authorization and principal user with the path parameters.

To call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.

put/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}

Request

Path parameters

accountIdstring required

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

authorizationIdstring required

The ID of the user authorization.

userIdstring required

The ID of the principal user.

Request body

endDatestring

The end date for the user authorization. The default value is the max UTC value: 9999-12-31T23:59:59.0000000+00:00.

startDatestring

The start date for the user authorization. The default value is the current date and time.

Response

Successful response.

authorizationIdstring

The ID of the user authorization.

createdstring

The UTC DateTime when the workspace user authorization was created.

createdBystring

The name and email of the user who created the authorization, in the following format: [Francis Beagle email@example.com]

endDatestring

The UTC DateTime at which the authorization will expire.

modifiedstring

The UTC DateTime when the workspace user authorization was last updated.

modifiedBystring

The name and email of the user who created the authorization, in the following format: [Francis Beagle email@example.com]

permissionstring

The permission level to grant the agent. Valid values:

  • Send
  • Manage
  • Sign
  • Edit

This property is required.

startDatestring

The UTC DateTime at which the authorization will start.

taskSourcestring
taskTypestring

Changes