docusign.request-logs.put-request-log-settings

Enables or disables API request logging for troubleshooting. When enabled (apiRequestLogging is true), REST API requests and responses for the user are added to a log. A log can have up to 50 requests/responses and the current number of log entries can be determined by getting the settings. Logging is automatically disabled when the log limit of 50 is reached. You can call Diagnostics: getRequestLog or Diagnostics: listRequestLogs to download the log files (individually or as a zip file). Call Diagnostics: deleteRequestLogs to clear the log by deleting current entries. Private information, such as passwords and integration key information, which is normally located in the call header is omitted from the request/response log. API request logging only captures requests from the authenticated user. Any call that does not authenticate the user and resolve a userId is not logged.

Enables or disables API request logging for troubleshooting.

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
apirequestlogging	string	No	—	When true, enables API request logging for the user.
apirequestlogmaxentries	string	No	—	Specifies the maximum number of API requests to log.
apirequestlogremainingentries	string	No	—	Indicates the remaining number of API requests that can be logged.

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
apirequestlogging	string	No	—	When true, enables API request logging for the user.
apirequestlogmaxentries	string	No	—	Specifies the maximum number of API requests to log.
apirequestlogremainingentries	string	No	—	Indicates the remaining number of API requests that can be logged.
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/diagnostics/settings
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/diagnostics/settings
* (any state)	fail	failed	Record the failure reason

API Usage

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

{
  "workflow_type": "docusign.request-logs.put-request-log-settings",
  "initial_data": {
    "base_url": "value"
  }
}