{ "opencollection": "1.0.0", "info": { "name": "DocuSign Admin AccountBrands ConnectConfigurations API", "version": "v2.1" }, "items": [ { "info": { "name": "ConnectConfigurations", "type": "folder" }, "items": [ { "info": { "name": "Docusign Get Connect Configuration Information", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/connect", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." } ] }, "docs": "Retrieves all the DocuSign Custom Connect definitions for the specified account.\n\n###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce." }, { "info": { "name": "Docusign Creates a connect configuration for the specified account.", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/connect", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself." }, { "info": { "name": "Docusign Updates a specified Connect configuration.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/connect", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified DocuSign Connect configuration in your account.\n\n###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce." }, { "info": { "name": "Docusign Get information on a Connect Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/connect/:connectId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "connectId", "value": "", "type": "path", "description": "The ID of the custom Connect configuration being accessed." } ] }, "docs": "Retrieves the information for the specified DocuSign Connect configuration.\n\n###### Note: Connect must be enabled for your account to use this function.\n" }, { "info": { "name": "Docusign Deletes the specified connect configuration.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/connect/:connectId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "connectId", "value": "", "type": "path", "description": "The ID of the custom Connect configuration being accessed." } ] }, "docs": "Deletes the specified DocuSign Connect configuration.\n\n###### Note: Connect must be enabled for your account to use this function.\n\n \n" }, { "info": { "name": "Docusign Returns users from the configured Connect service.", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/connect/:connectId/users", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "connectId", "value": "", "type": "path", "description": "The ID of the custom Connect configuration being accessed." }, { "name": "count", "value": "", "type": "query", "description": "Optional. Number of items to return.\n" }, { "name": "email_substring", "value": "", "type": "query", "description": "Filters the returned user records by the email address or a sub-string of email address." }, { "name": "list_included_users", "value": "", "type": "query" }, { "name": "start_position", "value": "", "type": "query", "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." }, { "name": "status", "value": "", "type": "query", "description": "Filters the results by user status.\nYou can specify a comma-separated\nlist of the following statuses:\n\n* ActivationRequired \n* ActivationSent \n* Active\n* Closed \n* Disabled\n" }, { "name": "user_name_substring", "value": "", "type": "query", "description": "Filters the user records returned by the user name or a sub-string of user name." } ] }, "docs": "Returns users from the configured Connect service." } ] } ], "bundled": true }