Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.referrals.deleteProgram({
referralProgramId: "<id>",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.referrals.delete_program(
referral_program_id="<id>",
)curl --request POST \
--url https://api.useautumn.com/v1/referral_programs.delete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"referral_program_id": "<string>"
}
'{
"success": true
}
Rewards & Referrals
Delete Referral Program
Delete a referral program.
POST
/
v1
/
referral_programs.delete
Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.referrals.deleteProgram({
referralProgramId: "<id>",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.referrals.delete_program(
referral_program_id="<id>",
)curl --request POST \
--url https://api.useautumn.com/v1/referral_programs.delete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"referral_program_id": "<string>"
}
'{
"success": true
}
Body Parameters
Response
{
"success": true
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
The ID of the referral program.
Minimum string length:
1Response
200 - application/json
OK