Skip to main content
PATCH
/
v1
/
referrals
/
{id}
/
deny
Deny
curl --request PATCH \
  --url https://{defaultHost}/v1/referrals/{id}/deny \
  --header 'Authorization: Bearer <token>'
{
  "id": "a86e3725-af70-4d16-bbe6-339984b2cedf",
  "object": "referral",
  "commission_amount": 9900,
  "currency": "usd",
  "description": null,
  "live_mode": true,
  "manual": true,
  "refund_reduction_amount": 0,
  "status": "denied",
  "affiliation": "cc613ae0-ab3e-471b-bd75-1b1c97a2078e",
  "attributed_click": null,
  "checkout": null,
  "payout": null,
  "created_at": 1767909753,
  "updated_at": 1767909753
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
commission_amount
integer

The amount in cents that will be paid out to the affiliate for this referral.

​
description
string | null

A brief description of what this referral is for.

​
live_mode
boolean

Set to true if this referral is in live mode, and set to false if it is in test mode.

​
currency
string

Three-letter ISO currency code, in lowercase. If not set, this value will fallback to the default Account currency.

​
manual
boolean

Whether or not this referral was created manually or automatically from a tracked click associated with a checkout.

​
status
string

The status of the referral – one of approved, canceled, denied, paid, or reviewing.

​
refund_reduction_amount
integer

The amount in cents that is reduced from the original commission amount due to refunds.

​
affiliation

Expandable – The associated affiliation ID.

​
attributed_click

Expandable – The associated click ID.

​
checkout

Expandable – The associated checkout ID.

​
payout

Expandable – The associated payout ID.

​
referral_items

Expandable – Property not returned unless expanded.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.