| Field | Type | Required | Description |
|---|---|---|---|
program_id |
::String | ✔️ | The ID of the program that the partner is enrolled in. |
partner_id |
T.nilable(::String) | ➖ | The ID of the partner to create a link for. Will take precedence over tenantId if provided. |
tenant_id |
T.nilable(::String) | ➖ | The ID of the partner in your system. If both partnerId and tenantId are not provided, an error will be thrown. |
url |
T.nilable(::String) | ➖ | The URL to shorten (if not provided, the program's default URL will be used). Will throw an error if the domain doesn't match the program's default URL domain. |
key |
T.nilable(::String) | ➖ | The short link slug. If not provided, a random 7-character slug will be generated. |
comments |
T.nilable(::String) | ➖ | The comments for the short link. |
link_props |
T.nilable(::OpenApiSDK::Operations::CreatePartnerLinkLinkProps) | ➖ | Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner. |