| Field | Type | Required | Description |
|---|---|---|---|
name |
OptionalNullable[str] | ➖ | The partner's full name. If undefined, the partner's email will be used in lieu of their name (e.g. john@acme.com) |
email |
str | ✔️ | The partner's email address. Partners will be able to claim their profile by signing up at partners.dub.co with this email. |
username |
OptionalNullable[str] | ➖ | 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. |
image |
OptionalNullable[str] | ➖ | The partner's avatar image. If not provided, a default avatar will be used. |
tenant_id |
Optional[str] | ➖ | 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. |
group_id |
Optional[str] | ➖ | The group ID to add the partner to. If not provided, the partner will be added to the default group. |
country |
OptionalNullable[str] | ➖ | 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 |
OptionalNullable[str] | ➖ | A brief description of the partner and their background. Max 5,000 characters. |
link_props |
Optional[operations.LinkProps] | ➖ | Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner. |