Ban a partner

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

1 min read

post/partners/ban

Request example

from dub import Dub


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

    res = d_client.partners.ban()

    # Handle response
    print(res)

Response

{
  "partnerId": "<string>"
}

post/partners/ban

Authorization

Authorizationstringheaderrequired#

Default authentication mechanism

application/json

partnerIdstring#

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

tenantIdstring#

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

reasonenum<string>required#

The reason for banning the partner.

Options:tos_violationinappropriate_contentfake_trafficfraudspambrand_abuse

application/json

The banned partner

partnerIdstringrequired#

The ID of the banned partner.