Skip to main content
POST
/
partners
/
ban
PHP
declare(strict_types=1);

require 'vendor/autoload.php';

use Dub;

$sdk = Dub\Dub::builder()
    ->setSecurity(
        'DUB_API_KEY'
    )
    ->build();



$response = $sdk->partners->ban(
    request: $request
);

if ($response->object !== null) {
    // handle response
}
{
  "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
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

The banned partner

​
partnerId
string
required

The ID of the banned partner.