Create a partner
Creates an onboarded partner together with their referral link. The link value defaults to a slug of the partner’s name or email and the parameter to the program’s first link parameter. Omit group_id to place the partner in the program’s default group.
Authorizations
Tolt API key sent as a bearer token.
Body
Partner's email address, where program emails such as the welcome email go. It identifies the partner in the program, so it cannot match another partner's email there, ignoring case.
"sam@acme.com"
Id of the program to add the partner to (prg_...), as returned when listing programs.
1"prg_YRsbPDAK"
Partner's first name. With last_name it is used for the default link value when link is omitted.
1 - 150"Sam"
Partner's last name. With first_name it makes up the name shown for the partner unless display_name is set.
1 - 150"Rivera"
Overrides the name shown for the partner; defaults to the first and last name.
1 - 150"Sam Rivera"
Business the partner promotes through, if they are a company rather than a person. Leave it out for an individual.
1 - 255"Acme"
Two-letter ISO country code.
^[A-Za-z]{2}$"US"
URL of the partner's website, starting with http:// or https://.
2048^https?:\/\/[^\s/\\]\S*$"https://acme.com"
Backdate the partner's creation time. Defaults to now.
"2024-01-15T10:00:00Z"
Group in the program. Defaults to the program's default group.
1"grp_1a2b3c"
Use pending to add the partner as an application that still needs approval instead of an active partner.
active, pending The referral link created with the partner. Leave it out to build the slug from the partner's name, or from the part of the email before the @ when there is no name.
Send the partner the program's welcome email. Only goes out when the program's welcome email is enabled and the partner is active.
true

