Overview
SDKs
- Overview
- Server-side SDKs
- Client-side SDK
- Embedded Dashboards
APIs
- Links API
- Analytics API
- Conversions API
- Partners API
- Customers API
- Commissions API
- Folders API
- Tags API
- Domains API
Partners API
Create a partner
Create a partner for a program. If partner exists, automatically enrolls them.
POST
/
partners
declare(strict_types=1);
require 'vendor/autoload.php';
use Dub;
use Dub\Models\Operations;
$sdk = Dub\Dub::builder()
->setSecurity(
'DUB_API_KEY'
)
->build();
$request = new Operations\CreatePartnerRequestBody(
programId: '<id>',
name: '<value>',
email: 'Summer50@yahoo.com',
linkProps: new Operations\LinkProps(
externalId: '123456',
tagIds: [
'clux0rgak00011...',
],
testVariants: [
new Operations\CreatePartnerTestVariants(
url: 'https://example.com/variant-1',
percentage: 50,
),
new Operations\CreatePartnerTestVariants(
url: 'https://example.com/variant-2',
percentage: 50,
),
],
),
);
$response = $sdk->partners->create(
request: $request
);
if ($response->object !== null) {
// handle response
}
{
"id": "<string>",
"name": "<string>",
"email": "<string>",
"image": "<string>",
"description": "<string>",
"country": "<string>",
"website": "<string>",
"youtube": "<string>",
"twitter": "<string>",
"linkedin": "<string>",
"instagram": "<string>",
"tiktok": "<string>",
"paypalEmail": "<string>",
"stripeConnectId": "<string>",
"payoutsEnabledAt": "<string>",
"createdAt": "<string>",
"status": "pending",
"programId": "<string>",
"tenantId": "<string>",
"links": [
{
"id": "<string>",
"domain": "<string>",
"key": "<string>",
"shortLink": "<string>",
"url": "<string>",
"clicks": 0,
"leads": 0,
"sales": 0,
"saleAmount": 0
}
],
"clicks": 0,
"leads": 0,
"sales": 0,
"saleAmount": 0,
"earnings": 0,
"applicationId": "<string>"
}
Partners endpoints require an Advanced plan subscription or higher.
Authorizations
Default authentication mechanism
Body
application/json
Response
201
application/json
The created partner
The response is of type object
.
declare(strict_types=1);
require 'vendor/autoload.php';
use Dub;
use Dub\Models\Operations;
$sdk = Dub\Dub::builder()
->setSecurity(
'DUB_API_KEY'
)
->build();
$request = new Operations\CreatePartnerRequestBody(
programId: '<id>',
name: '<value>',
email: 'Summer50@yahoo.com',
linkProps: new Operations\LinkProps(
externalId: '123456',
tagIds: [
'clux0rgak00011...',
],
testVariants: [
new Operations\CreatePartnerTestVariants(
url: 'https://example.com/variant-1',
percentage: 50,
),
new Operations\CreatePartnerTestVariants(
url: 'https://example.com/variant-2',
percentage: 50,
),
],
),
);
$response = $sdk->partners->create(
request: $request
);
if ($response->object !== null) {
// handle response
}
{
"id": "<string>",
"name": "<string>",
"email": "<string>",
"image": "<string>",
"description": "<string>",
"country": "<string>",
"website": "<string>",
"youtube": "<string>",
"twitter": "<string>",
"linkedin": "<string>",
"instagram": "<string>",
"tiktok": "<string>",
"paypalEmail": "<string>",
"stripeConnectId": "<string>",
"payoutsEnabledAt": "<string>",
"createdAt": "<string>",
"status": "pending",
"programId": "<string>",
"tenantId": "<string>",
"links": [
{
"id": "<string>",
"domain": "<string>",
"key": "<string>",
"shortLink": "<string>",
"url": "<string>",
"clicks": 0,
"leads": 0,
"sales": 0,
"saleAmount": 0
}
],
"clicks": 0,
"leads": 0,
"sales": 0,
"saleAmount": 0,
"earnings": 0,
"applicationId": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.