Delete referral

This is a soft delete: the referral is flagged deleted rather than removed. If the deleted referral had counted toward a bounty objective’s current progress, that count is rolled back and the objective is reopened. Progress the bounty has already moved past is left alone.

Authorizations

X-SHARED-SECRET

required

stringheader

Send your secret API key (nexus_sk_...) in the X-SHARED-SECRET header. Generate one in the Publisher Dashboard.

Parameters

Path Parameters

referralId

required

string

Example

2ixlNNFdJh-9scoXek80w

ID of referral to delete

Query Parameters

groupId

string

Example

V1StGXR8_Z5jdHi6B1LiO

Creator group to use for this operation. If you are using a program-scoped key, that key’s group is always used regardless of this value. Otherwise, this falls back to your default group when omitted.

Responses

200

Referral deleted successfully

404

Referral not found

DELETE

/{referralId}

const url = 'https://api.nexus.gg/v1/referrals/2ixlNNFdJh-9scoXek80w?groupId=V1StGXR8_Z5jdHi6B1LiO';
const options = {method: 'DELETE', headers: {'X-SHARED-SECRET': 'nexus_sk_your_key_here'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url 'https://api.nexus.gg/v1/referrals/2ixlNNFdJh-9scoXek80w?groupId=V1StGXR8_Z5jdHi6B1LiO' \
  --header 'X-SHARED-SECRET: nexus_sk_your_key_here'