Deactivate a partner

This will deactivate the partner from your program and disable all their active links. Their commissions and payouts will remain intact. You can reactivate them later if needed.

POST /partners/deactivate

TypeScript

TypeScript

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.partners.deactivate();

  console.log(result);
}

run();

200

{
  "partnerId": "<string>"
}

Partners endpoints require an Advanced plan subscription or higher.

Authorizations

Authorization · string · header · required

Default authentication mechanism

Body

application/json

partnerId · string | null

The ID of the partner to create a link for. Will take precedence over tenantId if provided.

tenantId · string | null

The ID of the partner in your system. If both partnerId and tenantId are not provided, an error will be thrown.

Response

200

application/json

The deactivated partner

partnerId · string · required

The ID of the deactivated partner.