Skip to main content
POST
Create a partner

Authorizations

Authorization
string
header
required

Tolt API key sent as a bearer token.

Body

application/json
email
string<email>
required

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.

Example:

"sam@acme.com"

program_id
string
required

Id of the program to add the partner to (prg_...), as returned when listing programs.

Minimum string length: 1
Example:

"prg_YRsbPDAK"

first_name
string

Partner's first name. With last_name it is used for the default link value when link is omitted.

Required string length: 1 - 150
Example:

"Sam"

last_name
string

Partner's last name. With first_name it makes up the name shown for the partner unless display_name is set.

Required string length: 1 - 150
Example:

"Rivera"

display_name
string

Overrides the name shown for the partner; defaults to the first and last name.

Required string length: 1 - 150
Example:

"Sam Rivera"

company_name
string

Business the partner promotes through, if they are a company rather than a person. Leave it out for an individual.

Required string length: 1 - 255
Example:

"Acme"

country_code
string

Two-letter ISO country code.

Pattern: ^[A-Za-z]{2}$
Example:

"US"

website_url
string<uri>

URL of the partner's website, starting with http:// or https://.

Maximum string length: 2048
Pattern: ^https?:\/\/[^\s/\\]\S*$
Example:

"https://acme.com"

created_at
string<date-time>

Backdate the partner's creation time. Defaults to now.

Example:

"2024-01-15T10:00:00Z"

group_id
string

Group in the program. Defaults to the program's default group.

Minimum string length: 1
Example:

"grp_1a2b3c"

status
enum<string>
default:active

Use pending to add the partner as an application that still needs approval instead of an active partner.

Available options:
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.

notify_partner
boolean

Send the partner the program's welcome email. Only goes out when the program's welcome email is enabled and the partner is active.

Example:

true

Response

The created partner with its referral link

success
boolean
required
Example:

true

message
string
required
Example:

"Request successful"

data
object
required