Create a referrals embed token

Create a referrals embed token for the given partner/tenant.

POST /tokens/embed/referrals

Ruby

Ruby

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

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