Submissions

Deletes Multiple Module Submissions

Deletes multiple module submission based on the ID supplied. Note that module submissions are soft-deleted (marked deleted, but not removed). Default Max Limit per request is 50

Authorization Required:

See Submission Access (Submission Access)

delete/modules/{moduleId}/submissions

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/submissions/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

moduleIdstring required

Unique module ID

Query parameters

destroyboolean

Whether to hard delete the submission from database. Value of 'destroy=true' will delete the submission. This option requires administrator privileges. Once deleted, the submission cannot be retrieved.

idsstring

A comma seperated list of the ids required to be deleted. Note - Max limit is 50 Per Request Example - ?ids=id1,id2,id3....

Response

Submission deleted

idstring

statusinteger

messagestring

Failure message

Changes

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