Create a referrals embed token

Create a referrals embed token for the given partner/tenant. The endpoint first attempts to locate an existing enrollment using the provided tenantId. If no enrollment is found, it resolves the partner by email and creates a new enrollment as needed. This results in an upsert-style flow that guarantees a valid enrollment and returns a usable embed token.

POST /tokens/embed/referrals

PHP

PHP

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\CreateReferralsEmbedTokenRequestBody(
    partner: new Operations\Partner(
        email: '[e-mail]',
        linkProps: new Operations\CreateReferralsEmbedTokenLinkProps(
            externalId: '123456',
            tagIds: [
                'clux0rgak00011...',
            ],
            testVariants: [
                new Operations\CreateReferralsEmbedTokenTestVariants(
                    url: 'https://example.com/variant-1',
                    percentage: 50,
                ),
                new Operations\CreateReferralsEmbedTokenTestVariants(
                    url: 'https://example.com/variant-2',
                    percentage: 50,
                ),
            ],
        ),
    ),
);

$response = $sdk->embedTokens->referrals(
    request: $request
);

if ($response->object !== null) {
    // handle response
}

201

{
  "publicToken": "<string>",
  "expires": "<string>"
}

Referrals embed token endpoint require an Advanced plan subscription or higher.

Authorizations

Authorization · string · header · required

Default authentication mechanism

Body

application/json

partnerId · string

tenantId · string

partner · object

Show child attributes

Response

201

application/json

The created public embed token.

publicToken · string · required

expires · string · required