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
}

package main

import(
	"context"
	dubgo "github.com/dubinc/dub-go"
	"github.com/dubinc/dub-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := dubgo.New(
        dubgo.WithSecurity("DUB_API_KEY"),
    )

    res, err := s.EmbedTokens.Referrals(ctx, &operations.CreateReferralsEmbedTokenRequestBody{
        Partner: &operations.Partner{
            Email: "[e-mail]",
            LinkProps: &operations.CreateReferralsEmbedTokenLinkProps{
                ExternalID: dubgo.Pointer("123456"),
                TagIds: dubgo.Pointer(operations.CreateCreateReferralsEmbedTokenTagIdsArrayOfStr(
                    []string{
                        "clux0rgak00011...",
                    },
                )),
                TestVariants: []operations.CreateReferralsEmbedTokenTestVariants{
                    operations.CreateReferralsEmbedTokenTestVariants{
                        URL: "https://example.com/variant-1",
                        Percentage: 50.0,
                    },
                    operations.CreateReferralsEmbedTokenTestVariants{
                        URL: "https://example.com/variant-2",
                        Percentage: 50.0,
                    },
                },
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

require 'dub'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Dub.new(
  security: Models::Shared::Security.new(
    token: 'DUB_API_KEY'
  )
)

req = Models::Operations::CreateReferralsEmbedTokenRequestBody.new(
  partner: Models::Operations::Partner.new(
    email: '[e-mail]',
    link_props: Models::Operations::CreateReferralsEmbedTokenLinkProps.new(
      external_id: '123456',
      tag_ids: [
        'clux0rgak00011...',
      ],
      test_variants: [
        Models::Operations::CreateReferralsEmbedTokenTestVariants.new(
          url: 'https://example.com/variant-1',
          percentage: 50.0
        ),
        Models::Operations::CreateReferralsEmbedTokenTestVariants.new(
          url: 'https://example.com/variant-2',
          percentage: 50.0
        ),
      ]
    )
  )
)
res = s.embed_tokens.referrals(request: req)

unless res.nil?
  # handle response
end

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.embedTokens.referrals();

  console.log(result);
}

run();

from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.embed_tokens.referrals(request={
        "partner": {
            "email": "[e-mail]",
            "link_props": {
                "external_id": "123456",
                "tag_ids": [
                    "clux0rgak00011...",
                ],
                "test_variants": [
                    {
                        "url": "https://example.com/variant-1",
                        "percentage": 50,
                    },
                    {
                        "url": "https://example.com/variant-2",
                        "percentage": 50,
                    },
                ],
            },
        },
    })

    # Handle response
    print(res)

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

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

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

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

201

{
  "publicToken": "<string>",
  "expires": "<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"
  }
}

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