---
title: "Create referral"
method: POST
path: "/v1/applications/{applicationId}/referrals"
tags: ["Referrals"]
---

# Create referral

`POST /v1/applications/{applicationId}/referrals`

Create an application snapshot with a code that can be redeemed by another organisation to create a new application with the same data.

## Path parameters

- `applicationId` string, required

## Request body

- CreateReferralParams
  - `reference` string — Optional default reference to use for applications created from this referral. Defaults to the source application reference.

## Response `200`

Success

- Referral — An application snapshot that can be redeemed by another organisation to create a new application with copied resources.
  - `_id` string, required — The unique ID of the referral.
  - `code` string, required — A referral code using the format `AK_` followed by 10 uppercase alphanumeric characters.
  - `reference` string, required — The default reference that applications created from this referral will use.
  - `expires_at` string, date-time, required — The time after which the referral code can no longer be redeemed.
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `redeemed_by` ReferralOrgDetails[], required — Organisations that have successfully redeemed this referral.
    - `name` string, required
    - `logo` string — A URL referencing the org's logo in PNG format.

## 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-enduring-api.md) · [All operations](https://skmtc.dev/akahu/apis/akahu-enduring-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/akahu/akahu-enduring-api/revisions/b2de9915920d/schema)