Create or update a partner

curl --request POST \
  --url https://api.dub.co/partners \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "name": "<string>",
  "username": "<string>",
  "image": "<string>",
  "tenantId": "<string>",
  "groupId": "<string>",
  "tagIds": [
    "<string>"
  ],
  "tagNames": [
    "<string>"
  ],
  "country": "<string>",
  "description": "<string>",
  "linkProps": {
    "externalId": "123456",
    "tenantId": "<string>",
    "prefix": "<string>",
    "archived": true,
    "tagIds": [
      "clux0rgak00011..."
    ],
    "tagNames": "<string>",
    "comments": "<string>",
    "expiresAt": "<string>",
    "expiredUrl": "<string>",
    "password": "<string>",
    "proxy": true,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "video": "<string>",
    "rewrite": true,
    "ios": "<string>",
    "android": "<string>",
    "doIndex": true,
    "testVariants": [
      {
        "url": "https://example.com/variant-1",
        "percentage": 50
      },
      {
        "url": "https://example.com/variant-2",
        "percentage": 50
      }
    ],
    "testStartedAt": "<string>",
    "testCompletedAt": "<string>"
  }
}
'

import requests

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

payload = {
    "email": "jsmith@example.com",
    "name": "<string>",
    "username": "<string>",
    "image": "<string>",
    "tenantId": "<string>",
    "groupId": "<string>",
    "tagIds": ["<string>"],
    "tagNames": ["<string>"],
    "country": "<string>",
    "description": "<string>",
    "linkProps": {
        "externalId": "123456",
        "tenantId": "<string>",
        "prefix": "<string>",
        "archived": True,
        "tagIds": ["clux0rgak00011..."],
        "tagNames": "<string>",
        "comments": "<string>",
        "expiresAt": "<string>",
        "expiredUrl": "<string>",
        "password": "<string>",
        "proxy": True,
        "title": "<string>",
        "description": "<string>",
        "image": "<string>",
        "video": "<string>",
        "rewrite": True,
        "ios": "<string>",
        "android": "<string>",
        "doIndex": True,
        "testVariants": [
            {
                "url": "https://example.com/variant-1",
                "percentage": 50
            },
            {
                "url": "https://example.com/variant-2",
                "percentage": 50
            }
        ],
        "testStartedAt": "<string>",
        "testCompletedAt": "<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({
    email: 'jsmith@example.com',
    name: '<string>',
    username: '<string>',
    image: '<string>',
    tenantId: '<string>',
    groupId: '<string>',
    tagIds: ['<string>'],
    tagNames: ['<string>'],
    country: '<string>',
    description: '<string>',
    linkProps: {
      externalId: '123456',
      tenantId: '<string>',
      prefix: '<string>',
      archived: true,
      tagIds: ['clux0rgak00011...'],
      tagNames: '<string>',
      comments: '<string>',
      expiresAt: '<string>',
      expiredUrl: '<string>',
      password: '<string>',
      proxy: true,
      title: '<string>',
      description: '<string>',
      image: '<string>',
      video: '<string>',
      rewrite: true,
      ios: '<string>',
      android: '<string>',
      doIndex: true,
      testVariants: [
        {url: 'https://example.com/variant-1', percentage: 50},
        {url: 'https://example.com/variant-2', percentage: 50}
      ],
      testStartedAt: '<string>',
      testCompletedAt: '<string>'
    }
  })
};

fetch('https://api.dub.co/partners', 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",
  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([
    'email' => 'jsmith@example.com',
    'name' => '<string>',
    'username' => '<string>',
    'image' => '<string>',
    'tenantId' => '<string>',
    'groupId' => '<string>',
    'tagIds' => [
        '<string>'
    ],
    'tagNames' => [
        '<string>'
    ],
    'country' => '<string>',
    'description' => '<string>',
    'linkProps' => [
        'externalId' => '123456',
        'tenantId' => '<string>',
        'prefix' => '<string>',
        'archived' => true,
        'tagIds' => [
                'clux0rgak00011...'
        ],
        'tagNames' => '<string>',
        'comments' => '<string>',
        'expiresAt' => '<string>',
        'expiredUrl' => '<string>',
        'password' => '<string>',
        'proxy' => true,
        'title' => '<string>',
        'description' => '<string>',
        'image' => '<string>',
        'video' => '<string>',
        'rewrite' => true,
        'ios' => '<string>',
        'android' => '<string>',
        'doIndex' => true,
        'testVariants' => [
                [
                                'url' => 'https://example.com/variant-1',
                                'percentage' => 50
                ],
                [
                                'url' => 'https://example.com/variant-2',
                                'percentage' => 50
                ]
        ],
        'testStartedAt' => '<string>',
        'testCompletedAt' => '<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"

	payload := strings.NewReader("{\n  \"email\": \"jsmith@example.com\",\n  \"name\": \"<string>\",\n  \"username\": \"<string>\",\n  \"image\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"groupId\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"tagNames\": [\n    \"<string>\"\n  ],\n  \"country\": \"<string>\",\n  \"description\": \"<string>\",\n  \"linkProps\": {\n    \"externalId\": \"123456\",\n    \"tenantId\": \"<string>\",\n    \"prefix\": \"<string>\",\n    \"archived\": true,\n    \"tagIds\": [\n      \"clux0rgak00011...\"\n    ],\n    \"tagNames\": \"<string>\",\n    \"comments\": \"<string>\",\n    \"expiresAt\": \"<string>\",\n    \"expiredUrl\": \"<string>\",\n    \"password\": \"<string>\",\n    \"proxy\": true,\n    \"title\": \"<string>\",\n    \"description\": \"<string>\",\n    \"image\": \"<string>\",\n    \"video\": \"<string>\",\n    \"rewrite\": true,\n    \"ios\": \"<string>\",\n    \"android\": \"<string>\",\n    \"doIndex\": true,\n    \"testVariants\": [\n      {\n        \"url\": \"https://example.com/variant-1\",\n        \"percentage\": 50\n      },\n      {\n        \"url\": \"https://example.com/variant-2\",\n        \"percentage\": 50\n      }\n    ],\n    \"testStartedAt\": \"<string>\",\n    \"testCompletedAt\": \"<string>\"\n  }\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jsmith@example.com\",\n  \"name\": \"<string>\",\n  \"username\": \"<string>\",\n  \"image\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"groupId\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"tagNames\": [\n    \"<string>\"\n  ],\n  \"country\": \"<string>\",\n  \"description\": \"<string>\",\n  \"linkProps\": {\n    \"externalId\": \"123456\",\n    \"tenantId\": \"<string>\",\n    \"prefix\": \"<string>\",\n    \"archived\": true,\n    \"tagIds\": [\n      \"clux0rgak00011...\"\n    ],\n    \"tagNames\": \"<string>\",\n    \"comments\": \"<string>\",\n    \"expiresAt\": \"<string>\",\n    \"expiredUrl\": \"<string>\",\n    \"password\": \"<string>\",\n    \"proxy\": true,\n    \"title\": \"<string>\",\n    \"description\": \"<string>\",\n    \"image\": \"<string>\",\n    \"video\": \"<string>\",\n    \"rewrite\": true,\n    \"ios\": \"<string>\",\n    \"android\": \"<string>\",\n    \"doIndex\": true,\n    \"testVariants\": [\n      {\n        \"url\": \"https://example.com/variant-1\",\n        \"percentage\": 50\n      },\n      {\n        \"url\": \"https://example.com/variant-2\",\n        \"percentage\": 50\n      }\n    ],\n    \"testStartedAt\": \"<string>\",\n    \"testCompletedAt\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"email\": \"jsmith@example.com\",\n  \"name\": \"<string>\",\n  \"username\": \"<string>\",\n  \"image\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"groupId\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"tagNames\": [\n    \"<string>\"\n  ],\n  \"country\": \"<string>\",\n  \"description\": \"<string>\",\n  \"linkProps\": {\n    \"externalId\": \"123456\",\n    \"tenantId\": \"<string>\",\n    \"prefix\": \"<string>\",\n    \"archived\": true,\n    \"tagIds\": [\n      \"clux0rgak00011...\"\n    ],\n    \"tagNames\": \"<string>\",\n    \"comments\": \"<string>\",\n    \"expiresAt\": \"<string>\",\n    \"expiredUrl\": \"<string>\",\n    \"password\": \"<string>\",\n    \"proxy\": true,\n    \"title\": \"<string>\",\n    \"description\": \"<string>\",\n    \"image\": \"<string>\",\n    \"video\": \"<string>\",\n    \"rewrite\": true,\n    \"ios\": \"<string>\",\n    \"android\": \"<string>\",\n    \"doIndex\": true,\n    \"testVariants\": [\n      {\n        \"url\": \"https://example.com/variant-1\",\n        \"percentage\": 50\n      },\n      {\n        \"url\": \"https://example.com/variant-2\",\n        \"percentage\": 50\n      }\n    ],\n    \"testStartedAt\": \"<string>\",\n    \"testCompletedAt\": \"<string>\"\n  }\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "username": "<string>",
  "email": "<string>",
  "image": "<string>",
  "country": "<string>",
  "companyName": "<string>",
  "networkStatus": "draft",
  "defaultPayoutMethod": "connect",
  "paypalEmail": "<string>",
  "stripeConnectId": "<string>",
  "payoutsEnabledAt": "<string>",
  "identityVerifiedAt": "<string>",
  "programId": "<string>",
  "partnerId": "<string>",
  "tenantId": "<string>",
  "createdAt": "<string>",
  "status": "pending",
  "links": [
    {
      "id": "<string>",
      "domain": "<string>",
      "key": "<string>",
      "shortLink": "<string>",
      "url": "<string>",
      "clicks": 0,
      "leads": 0,
      "conversions": 0,
      "sales": 0,
      "saleAmount": 0
    }
  ],
  "totalCommissions": 0,
  "totalClicks": 0,
  "totalLeads": 0,
  "totalConversions": 0,
  "totalSales": 0,
  "totalSaleAmount": 0,
  "netRevenue": 0,
  "description": "<string>",
  "groupId": "<string>",
  "clickRewardId": "<string>",
  "leadRewardId": "<string>",
  "saleRewardId": "<string>",
  "referralRewardId": "<string>",
  "customRewardId": "<string>",
  "discountId": "<string>",
  "applicationId": "<string>",
  "bannedAt": "<string>",
  "bannedReason": "tos_violation",
  "application": {
    "rejectionReason": "needsMoreDetail",
    "rejectionNote": "<string>",
    "reviewedAt": "<string>"
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "earningsPerClick": 123,
  "averageLifetimeValue": 123,
  "clickToLeadRate": 123,
  "clickToConversionRate": 123,
  "leadToConversionRate": 123,
  "returnOnAdSpend": 123,
  "website": "<string>",
  "youtube": "<string>",
  "twitter": "<string>",
  "linkedin": "<string>",
  "instagram": "<string>",
  "tiktok": "<string>",
  "trustedAt": "<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

Create or update a partner

curl --request POST \
  --url https://api.dub.co/partners \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "name": "<string>",
  "username": "<string>",
  "image": "<string>",
  "tenantId": "<string>",
  "groupId": "<string>",
  "tagIds": [
    "<string>"
  ],
  "tagNames": [
    "<string>"
  ],
  "country": "<string>",
  "description": "<string>",
  "linkProps": {
    "externalId": "123456",
    "tenantId": "<string>",
    "prefix": "<string>",
    "archived": true,
    "tagIds": [
      "clux0rgak00011..."
    ],
    "tagNames": "<string>",
    "comments": "<string>",
    "expiresAt": "<string>",
    "expiredUrl": "<string>",
    "password": "<string>",
    "proxy": true,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "video": "<string>",
    "rewrite": true,
    "ios": "<string>",
    "android": "<string>",
    "doIndex": true,
    "testVariants": [
      {
        "url": "https://example.com/variant-1",
        "percentage": 50
      },
      {
        "url": "https://example.com/variant-2",
        "percentage": 50
      }
    ],
    "testStartedAt": "<string>",
    "testCompletedAt": "<string>"
  }
}
'

import requests

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

payload = {
    "email": "jsmith@example.com",
    "name": "<string>",
    "username": "<string>",
    "image": "<string>",
    "tenantId": "<string>",
    "groupId": "<string>",
    "tagIds": ["<string>"],
    "tagNames": ["<string>"],
    "country": "<string>",
    "description": "<string>",
    "linkProps": {
        "externalId": "123456",
        "tenantId": "<string>",
        "prefix": "<string>",
        "archived": True,
        "tagIds": ["clux0rgak00011..."],
        "tagNames": "<string>",
        "comments": "<string>",
        "expiresAt": "<string>",
        "expiredUrl": "<string>",
        "password": "<string>",
        "proxy": True,
        "title": "<string>",
        "description": "<string>",
        "image": "<string>",
        "video": "<string>",
        "rewrite": True,
        "ios": "<string>",
        "android": "<string>",
        "doIndex": True,
        "testVariants": [
            {
                "url": "https://example.com/variant-1",
                "percentage": 50
            },
            {
                "url": "https://example.com/variant-2",
                "percentage": 50
            }
        ],
        "testStartedAt": "<string>",
        "testCompletedAt": "<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({
    email: 'jsmith@example.com',
    name: '<string>',
    username: '<string>',
    image: '<string>',
    tenantId: '<string>',
    groupId: '<string>',
    tagIds: ['<string>'],
    tagNames: ['<string>'],
    country: '<string>',
    description: '<string>',
    linkProps: {
      externalId: '123456',
      tenantId: '<string>',
      prefix: '<string>',
      archived: true,
      tagIds: ['clux0rgak00011...'],
      tagNames: '<string>',
      comments: '<string>',
      expiresAt: '<string>',
      expiredUrl: '<string>',
      password: '<string>',
      proxy: true,
      title: '<string>',
      description: '<string>',
      image: '<string>',
      video: '<string>',
      rewrite: true,
      ios: '<string>',
      android: '<string>',
      doIndex: true,
      testVariants: [
        {url: 'https://example.com/variant-1', percentage: 50},
        {url: 'https://example.com/variant-2', percentage: 50}
      ],
      testStartedAt: '<string>',
      testCompletedAt: '<string>'
    }
  })
};

fetch('https://api.dub.co/partners', 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",
  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([
    'email' => 'jsmith@example.com',
    'name' => '<string>',
    'username' => '<string>',
    'image' => '<string>',
    'tenantId' => '<string>',
    'groupId' => '<string>',
    'tagIds' => [
        '<string>'
    ],
    'tagNames' => [
        '<string>'
    ],
    'country' => '<string>',
    'description' => '<string>',
    'linkProps' => [
        'externalId' => '123456',
        'tenantId' => '<string>',
        'prefix' => '<string>',
        'archived' => true,
        'tagIds' => [
                'clux0rgak00011...'
        ],
        'tagNames' => '<string>',
        'comments' => '<string>',
        'expiresAt' => '<string>',
        'expiredUrl' => '<string>',
        'password' => '<string>',
        'proxy' => true,
        'title' => '<string>',
        'description' => '<string>',
        'image' => '<string>',
        'video' => '<string>',
        'rewrite' => true,
        'ios' => '<string>',
        'android' => '<string>',
        'doIndex' => true,
        'testVariants' => [
                [
                                'url' => 'https://example.com/variant-1',
                                'percentage' => 50
                ],
                [
                                'url' => 'https://example.com/variant-2',
                                'percentage' => 50
                ]
        ],
        'testStartedAt' => '<string>',
        'testCompletedAt' => '<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"

	payload := strings.NewReader("{\n  \"email\": \"jsmith@example.com\",\n  \"name\": \"<string>\",\n  \"username\": \"<string>\",\n  \"image\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"groupId\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"tagNames\": [\n    \"<string>\"\n  ],\n  \"country\": \"<string>\",\n  \"description\": \"<string>\",\n  \"linkProps\": {\n    \"externalId\": \"123456\",\n    \"tenantId\": \"<string>\",\n    \"prefix\": \"<string>\",\n    \"archived\": true,\n    \"tagIds\": [\n      \"clux0rgak00011...\"\n    ],\n    \"tagNames\": \"<string>\",\n    \"comments\": \"<string>\",\n    \"expiresAt\": \"<string>\",\n    \"expiredUrl\": \"<string>\",\n    \"password\": \"<string>\",\n    \"proxy\": true,\n    \"title\": \"<string>\",\n    \"description\": \"<string>\",\n    \"image\": \"<string>\",\n    \"video\": \"<string>\",\n    \"rewrite\": true,\n    \"ios\": \"<string>\",\n    \"android\": \"<string>\",\n    \"doIndex\": true,\n    \"testVariants\": [\n      {\n        \"url\": \"https://example.com/variant-1\",\n        \"percentage\": 50\n      },\n      {\n        \"url\": \"https://example.com/variant-2\",\n        \"percentage\": 50\n      }\n    ],\n    \"testStartedAt\": \"<string>\",\n    \"testCompletedAt\": \"<string>\"\n  }\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jsmith@example.com\",\n  \"name\": \"<string>\",\n  \"username\": \"<string>\",\n  \"image\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"groupId\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"tagNames\": [\n    \"<string>\"\n  ],\n  \"country\": \"<string>\",\n  \"description\": \"<string>\",\n  \"linkProps\": {\n    \"externalId\": \"123456\",\n    \"tenantId\": \"<string>\",\n    \"prefix\": \"<string>\",\n    \"archived\": true,\n    \"tagIds\": [\n      \"clux0rgak00011...\"\n    ],\n    \"tagNames\": \"<string>\",\n    \"comments\": \"<string>\",\n    \"expiresAt\": \"<string>\",\n    \"expiredUrl\": \"<string>\",\n    \"password\": \"<string>\",\n    \"proxy\": true,\n    \"title\": \"<string>\",\n    \"description\": \"<string>\",\n    \"image\": \"<string>\",\n    \"video\": \"<string>\",\n    \"rewrite\": true,\n    \"ios\": \"<string>\",\n    \"android\": \"<string>\",\n    \"doIndex\": true,\n    \"testVariants\": [\n      {\n        \"url\": \"https://example.com/variant-1\",\n        \"percentage\": 50\n      },\n      {\n        \"url\": \"https://example.com/variant-2\",\n        \"percentage\": 50\n      }\n    ],\n    \"testStartedAt\": \"<string>\",\n    \"testCompletedAt\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"email\": \"jsmith@example.com\",\n  \"name\": \"<string>\",\n  \"username\": \"<string>\",\n  \"image\": \"<string>\",\n  \"tenantId\": \"<string>\",\n  \"groupId\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"tagNames\": [\n    \"<string>\"\n  ],\n  \"country\": \"<string>\",\n  \"description\": \"<string>\",\n  \"linkProps\": {\n    \"externalId\": \"123456\",\n    \"tenantId\": \"<string>\",\n    \"prefix\": \"<string>\",\n    \"archived\": true,\n    \"tagIds\": [\n      \"clux0rgak00011...\"\n    ],\n    \"tagNames\": \"<string>\",\n    \"comments\": \"<string>\",\n    \"expiresAt\": \"<string>\",\n    \"expiredUrl\": \"<string>\",\n    \"password\": \"<string>\",\n    \"proxy\": true,\n    \"title\": \"<string>\",\n    \"description\": \"<string>\",\n    \"image\": \"<string>\",\n    \"video\": \"<string>\",\n    \"rewrite\": true,\n    \"ios\": \"<string>\",\n    \"android\": \"<string>\",\n    \"doIndex\": true,\n    \"testVariants\": [\n      {\n        \"url\": \"https://example.com/variant-1\",\n        \"percentage\": 50\n      },\n      {\n        \"url\": \"https://example.com/variant-2\",\n        \"percentage\": 50\n      }\n    ],\n    \"testStartedAt\": \"<string>\",\n    \"testCompletedAt\": \"<string>\"\n  }\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "username": "<string>",
  "email": "<string>",
  "image": "<string>",
  "country": "<string>",
  "companyName": "<string>",
  "networkStatus": "draft",
  "defaultPayoutMethod": "connect",
  "paypalEmail": "<string>",
  "stripeConnectId": "<string>",
  "payoutsEnabledAt": "<string>",
  "identityVerifiedAt": "<string>",
  "programId": "<string>",
  "partnerId": "<string>",
  "tenantId": "<string>",
  "createdAt": "<string>",
  "status": "pending",
  "links": [
    {
      "id": "<string>",
      "domain": "<string>",
      "key": "<string>",
      "shortLink": "<string>",
      "url": "<string>",
      "clicks": 0,
      "leads": 0,
      "conversions": 0,
      "sales": 0,
      "saleAmount": 0
    }
  ],
  "totalCommissions": 0,
  "totalClicks": 0,
  "totalLeads": 0,
  "totalConversions": 0,
  "totalSales": 0,
  "totalSaleAmount": 0,
  "netRevenue": 0,
  "description": "<string>",
  "groupId": "<string>",
  "clickRewardId": "<string>",
  "leadRewardId": "<string>",
  "saleRewardId": "<string>",
  "referralRewardId": "<string>",
  "customRewardId": "<string>",
  "discountId": "<string>",
  "applicationId": "<string>",
  "bannedAt": "<string>",
  "bannedReason": "tos_violation",
  "application": {
    "rejectionReason": "needsMoreDetail",
    "rejectionNote": "<string>",
    "reviewedAt": "<string>"
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "earningsPerClick": 123,
  "averageLifetimeValue": 123,
  "clickToLeadRate": 123,
  "clickToConversionRate": 123,
  "leadToConversionRate": 123,
  "returnOnAdSpend": 123,
  "website": "<string>",
  "youtube": "<string>",
  "twitter": "<string>",
  "linkedin": "<string>",
  "instagram": "<string>",
  "tiktok": "<string>",
  "trustedAt": "<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

string<email>

required

The partner's email address. Partners will be able to claim their profile by signing up at partners.dub.co with this email.

Maximum string length: 190

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

name

string | null

The partner's full name. If undefined, the partner's email will be used in lieu of their name (e.g. john@acme.com)

Maximum string length: 100

username

string | null

The partner's unique username in your system (max 100 characters). This will be used to create a short link for the partner using your program's default domain. If not provided, Dub will try to generate a username from the partner's name or email.

Maximum string length: 100

image

string | null

The partner's avatar image. If not provided, a default avatar will be used.

tenantId

string

The partner's unique ID in your system. Useful for retrieving the partner's links and stats later on. If not provided, the partner will be created as a standalone partner.

Maximum string length: 190

groupId

string

The group ID to add the partner to. If not provided, the partner will be added to the default group.

tagIds

string[]

The IDs of the partner tags to assign when creating the partner. Existing tags are kept. Takes priority over tagNames only when it contains at least one ID.

Maximum array length: 100

tagNames

string[]

The names of the partner tags to assign when creating the partner. Existing tags are kept. Ignored only when tagIds contains at least one ID.

Maximum array length: 100

country

string | null

The partner's country of residence. Must be passed as a 2-letter ISO 3166-1 country code. See https://d.to/geo for more information.

description

string | null

A brief description of the partner and their background. Max 5,000 characters.

Maximum string length: 5000

linkProps

object

Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner.

Show child attributes

Response

The created or updated partner

string

required

The partner's unique ID on Dub.

name

string

required

The partner's full legal name.

Maximum string length: 190

username

string | null

required

The partner's unique username on Dub.

string | null

required

The partner's email address. Should be a unique value across Dub.

Maximum string length: 190

image

string | null

required

The partner's avatar image.

country

string | null

required

The partner's country (required for tax purposes).

companyName

string | null

required

If the partner profile type is a company, this is the partner's legal company name.

Maximum string length: 190

networkStatus

enum<string>

required

The partner's network status on Dub.

Available options:

draft,

submitted,

approved,

rejected,

trusted,

banned

defaultPayoutMethod

enum<string> | null

required

The partner's default payout method. Connect: Bank account payouts via Stripe Connect; Stablecoin: USDC payouts directly to a crypto wallet; PayPal: Payouts via PayPal

Available options:

connect,

stablecoin,

paypal,

tremendous

paypalEmail

string | null

required

The partner's PayPal email (for receiving payouts via PayPal).

stripeConnectId

string | null

required

The partner's Stripe Connect ID (for receiving payouts via Stripe).

payoutsEnabledAt

string | null

required

The date when the partner enabled payouts.

identityVerifiedAt

string | null

required

The date when the partner's identity was verified.

programId

string

required

The program's unique ID on Dub.

partnerId

string

required

The partner's unique ID on Dub.

tenantId

string | null

required

The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future.

createdAt

string

required

status

enum<string>

required

The status of the partner's enrollment in the program.

Available options:

pending,

approved,

rejected,

invited,

declined,

deactivated,

banned,

archived

links

object[] | null

required

The partner's referral links in this program.

Show child attributes

totalCommissions

number

default:0

required

The total commissions paid to the partner for their referrals

totalClicks

number

default:0

required

The total number of clicks on the partner's links

totalLeads

number

default:0

required

The total number of leads generated by the partner's links

totalConversions

number

default:0

required

The total number of leads that converted to paying customers

totalSales

number

default:0

required

The total number of sales generated by the partner's links (includes recurring sales)

totalSaleAmount

number

default:0

required

Total revenue generated by the partner's links

netRevenue

number

default:0

required

Net revenue after commissions (Total Revenue - Total Commissions)

description

string | null

A brief description of the partner and their background.

Maximum string length: 5000

groupId

string | null

The partner's group ID on Dub.

clickRewardId

string | null

leadRewardId

string | null

saleRewardId

string | null

referralRewardId

string | null

customRewardId

string | null

discountId

string | null

applicationId

string | null

If the partner submitted an application to join the program, this is the ID of the application.

bannedAt

string | null

If the partner was banned from the program, this is the date of the ban.

bannedReason

enum<string> | null

If the partner was banned from the program, this is the reason for the ban.

Available options:

tos_violation,

inappropriate_content,

fake_traffic,

fraud,

spam,

brand_abuse

application

object | null

Linked program application, including review outcome when applicable.

Show child attributes

DUB API

SDKs

DUB PARTNERS API

DUB LINKS API

Create or update a partner

Authorizations

Body

Response