Ban a partner

Ban a partner from your program. This will disable all links and mark all commissions as canceled.

POST /partners/ban

Python

Python

from dub import Dub


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

    res = d_client.partners.ban()

    # 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

reason · enum<string> · required

The reason for banning the partner.

Available options: tos_violation, inappropriate_content, fake_traffic, fraud, spam, brand_abuse

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 banned partner

partnerId · string · required

The ID of the banned partner.