docusign.authorizations.update-user-authorization

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.

Updates the start or end date for a user authorization.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
authorizationid	string	Yes	—	The ID of the user authorization.
userid	string	Yes	—	The ID of the principal user.
enddate	string	No	—	The end date for the user authorization. The default value is the max UTC value: 9999-12-31T23:59:59.0000000+00:00.
startdate	string	No	—	The start date for the user authorization. The default value is the current date and time.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
authorizationid	string	Yes	—	The ID of the user authorization.
userid	string	Yes	—	The ID of the principal user.
enddate	string	No	—	The end date for the user authorization. The default value is the max UTC value: 9999-12-31T23:59:59.0000000+00:00.
startdate	string	No	—	The start date for the user authorization. The default value is the current date and time.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/accounts/{accountId}/users/{userId}/authorization/
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/accounts/{accountId}/users/{userId}/authorization/
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.authorizations.update-user-authorization",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "authorizationid": "value",
    "userid": "value"
  }
}