{ "opencollection": "1.0.0", "info": { "name": "DocuSign Admin AccountBrands FormGroups API", "version": "v2.1" }, "items": [ { "info": { "name": "FormGroups", "type": "folder" }, "items": [ { "info": { "name": "Docusign Gets form groups.", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/form_groups", "params": [ { "name": "count", "value": "", "type": "query", "description": "The number of results to return. This value must be a number between `1` and `100` (default)." }, { "name": "startPosition", "value": "", "type": "query", "description": "The starting zero-based index position of the results set. The default value is `0`." }, { "name": "accountId", "value": "", "type": "path", "description": "The globally unique identifier (GUID) for the account." } ] }, "docs": "Returns the company form groups to which the current user has access.\n\n## Permissions \n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**" }, { "info": { "name": "Docusign Creates a form group.", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/form_groups", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The globally unique identifier (GUID) for the account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new form group with the name given in the `name` property of the request body.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**" }, { "info": { "name": "Docusign Gets a form group.", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/form_groups/:formGroupId", "params": [ { "name": "formGroupId", "value": "", "type": "path", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n" }, { "name": "accountId", "value": "", "type": "path", "description": "The globally unique identifier (GUID) for the account." } ] }, "docs": "Get the specified form group.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**" }, { "info": { "name": "Docusign Renames a form group.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/form_groups/:formGroupId", "params": [ { "name": "formGroupId", "value": "", "type": "path", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n" }, { "name": "accountId", "value": "", "type": "path", "description": "The globally unique identifier (GUID) for the account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Renames the specified form group with the name given in the `name` property of the request.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**" }, { "info": { "name": "Docusign Deletes a form group.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/form_groups/:formGroupId", "params": [ { "name": "formGroupId", "value": "", "type": "path", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n" }, { "name": "accountId", "value": "", "type": "path", "description": "The globally unique identifier (GUID) for the account." } ] }, "docs": "Deletes the specified form group.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**" }, { "info": { "name": "Docusign Gets the user's form group forms.", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/form_groups/:formGroupId/forms", "params": [ { "name": "formGroupId", "value": "", "type": "path", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n" }, { "name": "count", "value": "", "type": "query", "description": "The number of results to return. \nDefault value is 100 and max value is 100\n" }, { "name": "startPosition", "value": "", "type": "query", "description": "The starting point of the list. The default is 0.\n" }, { "name": "accountId", "value": "", "type": "path", "description": "The globally unique identifier (GUID) for the account." } ] }, "docs": "Get forms of the specified form group." }, { "info": { "name": "Docusign Removes a form from a form group.", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/form_groups/:formGroupId/unassign_form/:formId", "params": [ { "name": "formGroupId", "value": "", "type": "path", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n" }, { "name": "formId", "value": "", "type": "path", "description": "The ID of the form." }, { "name": "accountId", "value": "", "type": "path", "description": "The globally unique identifier (GUID) for the account." } ] }, "docs": "Removes the form `formId` from the form group `formGroupId`.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**" }, { "info": { "name": "Docusign Assigns a form to a form group.", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/form_groups/:formGroupId/assign_form", "params": [ { "name": "formGroupId", "value": "", "type": "path", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n" }, { "name": "accountId", "value": "", "type": "path", "description": "The globally unique identifier (GUID) for the account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assigns the form specified in the `formId` property of the request to the form group `formGroupId`. Set the `isRequired` property in the request body to **true** if this is a required form.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**\n" }, { "info": { "name": "Docusign Grants an office access to a form group.", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/form_groups/:formGroupId/grant_office_access/:officeId", "params": [ { "name": "formGroupId", "value": "", "type": "path", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n" }, { "name": "officeId", "value": "", "type": "path", "description": "The ID of the office. This is the ID that the system generated when you created the office." }, { "name": "accountId", "value": "", "type": "path", "description": "The globally unique identifier (GUID) for the account." } ] }, "docs": "Grants the office `officeId` access to the form group `formGroupId`.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**" }, { "info": { "name": "Docusign Revoke an office's access to a form group.", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/form_groups/:formGroupId/revoke_office_access/:officeId", "params": [ { "name": "formGroupId", "value": "", "type": "path", "description": "The ID of the form group.\n\nExample: `7b879c89-xxxx-xxxx-xxxx-819d6a85e0a1`\n" }, { "name": "officeId", "value": "", "type": "path", "description": "The ID of the office. This is the ID that the system generated when you created the office." }, { "name": "accountId", "value": "", "type": "path", "description": "The globally unique identifier (GUID) for the account." } ] }, "docs": "Revoke access to the form group `formGroupId` from the office `officeId`.\n\n## Permissions\n\nYou must have a role for which the `canManageFormGroups` permission is set to **true.**" } ] } ], "bundled": true }