---
title: "Update application"
method: PUT
path: "/v1/applications/{applicationId}"
tags: ["Applications"]
---

# Update application

`PUT /v1/applications/{applicationId}`

## Request

- Base URL: `https://api.apply.akahu.nz`
- URL: `https://api.apply.akahu.nz/v1/applications/{applicationId}`
- Auth: HTTP bearer

## Path parameters

- `applicationId` string, required

## Request body

- ApplicationUpdateParams
  - `reference` string: 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.
  - `report_type` 'standard' | 'income': Changing `report_type` starts a new report for the application. Create or fetch the application's report as usual to get it.

## Response `200`

Success

- Application: The core function of Akahu Apply is to provide insights over a dataset consisting of financial accounts and their transactions. An Akahu Apply **Application** represents a container where data can be added, processed, and prepared for analysis. For example, if you are using Akahu Apply as part of a lending workflow, a new Application should be set up in Akahu Apply for each lending application being processed.
  - `_id` string, required
  - `reference` string, 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.
  - `report_type` 'standard' | 'income', required: The type of report generated for an application: - `standard` A full report covering accounts, income, expenses and transactions. - `income` A report focused on income.
  - `status` 'active' | 'archived', required
  - `last_applicant_submission_at` string, date-time: The date of the last submission by an applicant from a sharing request.
  - `archived_at` string, date-time: If this application has been archived, the date that it happened.
  - `created_at` string, date-time, required: The date this application was created.
  - `updated_at` string, date-time, required: The date this application was last updated.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/akahu/apis/akahu-apply-api.md) - [All operations](https://skmtc.dev/akahu/apis/akahu-apply-api/llms.txt) - [OpenAPI document](https://skmtc.dev/akahu/apis/akahu-apply-api/revisions/3f18eb1ead75?raw)