delete_referral_program
Remove a project's Referral Program. Destructive; refused while any affiliate is still owed a commission. Emits nothing.
Remove the programme a project runs. The shared Action refuses while any affiliate is still owed a
commission, because deleting would strand money the creator promised; record their payouts with
record_referral_payout first, or call
deactivate_referral_program, which stops the
programme and keeps everything.
Destructive — confirm with a human first
Confirm the target project_id with the creator before calling. Deleting
emits no event, so nothing downstream is told.
Idempotent: a project with no programme answers RESOURCE_NOT_FOUND, exactly as an unknown or
out-of-scope project does.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same action as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Annotations
A client that honours annotations asks a person before running it. Sending the same arguments twice changes nothing the second time.
Arguments
project_id*stringUUID of the project whose Referral Program to remove.
What it returns
{ "data": { "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13", "deleted": true }}How it fails
VALIDATION_FAILEDaffiliates are still owed commissions, or the caller's role lacks the team's
RESOURCE_NOT_FOUNDunknown project_id, a project on another team, one outside the token's
AUTHENTICATION_REQUIREDno authenticated user on the request.
TOKEN_MISSING_ABILITYtoken lacks project-referral:delete.
How is this guide?
Last updated on
deactivate_referral_program
Switch a project's Referral Program off — links stop attributing and payments stop earning, while what affiliates earned stays. Emits referral.program_updated.
get_referral
Fetch one referral — the affiliate, the friend's member id, how they arrived, whether they paid and until when the affiliate earns on them. Read-only.