---
title: "Create a referral campaign"
method: POST
path: "/v1/referrals"
tags: ["Referrals"]
---

# Create a referral campaign

`POST /v1/referrals`

## Request body

- ReferralParams
  - `name` string, required — Name of the new campaign
  - `cover_payment` boolean — Will the organization pay for these referred transactions? This will result in single use links. Default: false
  - `organization_id` string — ID of organization to create the campaign for, only needed when creating for a child organization
  - `redirect_url` string — URL that customers will be sent to from the referral. This can be set to an Easylink URL. Default: retail URL
  - `use_branding` boolean — Will the referred transactions display the orgs branding? Default: false

## Response `200`

Success

- ReferralObject
  - `referral_campaign_id` string — ID of the created campaign
  - `link` string — For campaigns that don't cover payment, this will be the referral link that you share with signers. For campaigns that cover payment, this will be null. You will be required to generate single use links.

## Other responses

- `400` — Bad Request
- `404` — Not Found

---

[API](https://skmtc.dev/proof/apis/proof-business-api-specification.md) · [All operations](https://skmtc.dev/proof/apis/proof-business-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/proof/proof-business-api-specification/revisions/1adaa0ea25cd/schema)