Modules

Restore a Deleted Module

Restores a soft-deleted module.

post/modules/{moduleId}/restore

Request

Base URL
https://env.unqork.io/api/1.0
Auth
OAuth 2
Client credentials
Password
Token URLhttps://xyzfinancial.unqork.io/api/1.0/oauth2/access_token
TypeScript
https://skmtc.dev/unqork/apis/unqork-customer-api/docs/modules/:moduleId/restore/post.ts
A function with typed inputs. Its response is checked against the schema.

moduleIdstring required

ID of module to restore

shareToEnvironmentboolean

Whether to share the module to the environment

NOTE: If specified, request cannot include workspaceId or applicationId.

workspaceIdstring

Workspace ID module will be shared with

Examples

Restore and share to workspace ID: 6053e968afcc293120198785

Request

 {
   "workspaceId": "6053e968afcc293120198785",
 }

NOTE: If applicationId also specified, will connect the module to the application (the application must be part of the workspace)

Restore and connect to application 6078e938d87660707f31c624 in workspace 6053e968afcc293120198785

Request

 {
   "workspaceId": "6053e968afcc293120198785",
   "applicationId": "6078e938d87660707f31c624"
 }

applicationIdstring

Application ID to which the module will be restored (will not share the module)

Example

Request

 {
   "applicationId": "6078e938d87660707f31c624"
 }

Successfully Restored

No recorded changes to this operation across all 6 revisions of this API.