Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
Referrals

Create referral

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

post/v1/applications/{applicationId}/referrals

Path parameters

applicationIdstring required
Example:application_tz4a98xxat96iws9zmbrgj3a

Request body

referencestring

Optional default reference to use for applications created from this referral. Defaults to the source application reference.

Response

Success

_idstring required

The unique ID of the referral.

codestring required

A referral code using the format AK_ followed by 10 uppercase alphanumeric characters.

referencestring required

The default reference that applications created from this referral will use.

expires_atstring date-time required

The time after which the referral code can no longer be redeemed.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "_id": "referral_tz4a98xxat96iws9zmbrgj3a",
  "code": "AK_23456789BC"
}