Ban a partner

curl --request POST \
  --url https://api.dub.co/partners/ban \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partnerId": "<string>",
  "tenantId": "<string>",
  "flagForFraud": true,
  "flagForFraudReason": "<string>"
}
'

import requests

url = "https://api.dub.co/partners/ban"

payload = {
    "partnerId": "<string>",
    "tenantId": "<string>",
    "flagForFraud": True,
    "flagForFraudReason": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    partnerId: '<string>',
    tenantId: '<string>',
    flagForFraud: true,
    flagForFraudReason: '<string>'
  })
};

fetch('https://api.dub.co/partners/ban', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dub.co/partners/ban",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'partnerId' => '<string>',
    'tenantId' => '<string>',
    'flagForFraud' => true,
    'flagForFraudReason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/partners/ban"

	payload := strings.NewReader("{\n  \"partnerId\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"flagForFraud\": true,\n  \"flagForFraudReason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dub.co/partners/ban")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"partnerId\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"flagForFraud\": true,\n  \"flagForFraudReason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dub.co/partners/ban")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"partnerId\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"flagForFraud\": true,\n  \"flagForFraudReason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "partnerId": "<string>"
}

{
  "error": {
    "code": "bad_request",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#bad-request"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#unauthorized"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#forbidden"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#not-found"
  }
}

{
  "error": {
    "code": "conflict",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#conflict"
  }
}

{
  "error": {
    "code": "invite_expired",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#invite-expired"
  }
}

{
  "error": {
    "code": "unprocessable_entity",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#unprocessable-entity"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#rate-limit_exceeded"
  }
}

{
  "error": {
    "code": "internal_server_error",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#internal-server_error"
  }
}

POST

partners

ban

Ban a partner

curl --request POST \
  --url https://api.dub.co/partners/ban \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partnerId": "<string>",
  "tenantId": "<string>",
  "flagForFraud": true,
  "flagForFraudReason": "<string>"
}
'

import requests

url = "https://api.dub.co/partners/ban"

payload = {
    "partnerId": "<string>",
    "tenantId": "<string>",
    "flagForFraud": True,
    "flagForFraudReason": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    partnerId: '<string>',
    tenantId: '<string>',
    flagForFraud: true,
    flagForFraudReason: '<string>'
  })
};

fetch('https://api.dub.co/partners/ban', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dub.co/partners/ban",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'partnerId' => '<string>',
    'tenantId' => '<string>',
    'flagForFraud' => true,
    'flagForFraudReason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/partners/ban"

	payload := strings.NewReader("{\n  \"partnerId\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"flagForFraud\": true,\n  \"flagForFraudReason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dub.co/partners/ban")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"partnerId\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"flagForFraud\": true,\n  \"flagForFraudReason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dub.co/partners/ban")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"partnerId\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"flagForFraud\": true,\n  \"flagForFraudReason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "partnerId": "<string>"
}

{
  "error": {
    "code": "bad_request",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#bad-request"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#unauthorized"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#forbidden"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#not-found"
  }
}

{
  "error": {
    "code": "conflict",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#conflict"
  }
}

{
  "error": {
    "code": "invite_expired",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#invite-expired"
  }
}

{
  "error": {
    "code": "unprocessable_entity",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#unprocessable-entity"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#rate-limit_exceeded"
  }
}

{
  "error": {
    "code": "internal_server_error",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#internal-server_error"
  }
}

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.

flagForFraud

boolean

Whether to flag the partner for fraud review by the Dub team.

flagForFraudReason

string

The reason for flagging the partner for fraud. Required when flagForFraud is true.

Maximum string length: 2000

Response

The banned partner

partnerId

string

required

The ID of the banned partner.

DUB API

SDKs

DUB PARTNERS API

DUB LINKS API

Ban a partner

Authorizations

Body

Response