Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
Applications

Archive application

An archived application can no longer have additional resources added to it.

Once archived, an application will be securely deleted after a preset number of days, which can be configured by an Akahu Apply organisation administrator.

put/v1/applications/{applicationId}/archive

Path parameters

applicationIdstring required
Example:application_tz4a98xxat96iws9zmbrgj3a

Response

Success

_idstring required
referencestring required

A value used to identify the application in a way that makes sense to the creator.

For some this may include the applicant names, for others it may be a unique reference from their CRM.

It does not need to be unique.

status'active' | 'archived' required
last_applicant_submission_atstring date-time

The date of the last submission by an applicant from a sharing request.

archived_atstring date-time

If this application has been archived, the date that it happened.

created_atstring date-time required

The date this application was created.

updated_atstring date-time required

The date this application was last updated.

Example response

{
  "_id": "application_tz4a98xxat96iws9zmbrgj3a"
}