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

Python

Python

from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.partners.deactivate()

    # Handle response
    print(res)

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.