---
title: "Redeem Referral"
method: POST
path: "/api/v1/purchase/referral/redeem"
tags: ["Purchase"]
---

# Redeem Referral

`POST /api/v1/purchase/referral/redeem`

## Request

- Base URL: `https://foto.damdafa.com/dreamhome`
- URL: `https://foto.damdafa.com/dreamhome/api/v1/purchase/referral/redeem`
- Auth: HTTP bearer

Validate a referral code and return the appropriate master offer code or token.

## Headers

- `ProviderId` 'firebase' | 'google' | 'apple'
- `X-Provider-Id` 'firebase' | 'google' | 'apple'
- `X-Device-Id` string, nullable

## Request body

- ReferralRedeemRequest: Request schema for redeeming a referral code.
  - `referral_code` string, required
  - `os` string, required

## Response `200`

Successful Response

- ReferralRedeemResponse: Response schema for redeeming a referral code.
  - `type` string, required
  - `code` string, nullable
  - `codes` union
    - object
    - object
  - `offerToken` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/damdafa/apis/homedecor-api.md) · [All operations](https://skmtc.dev/damdafa/apis/homedecor-api/llms.txt) · [OpenAPI document](https://skmtc.dev/damdafa/apis/homedecor-api/revisions/372f33a6d18e?raw)