Skip to main content
PUT
Update a partner

Authorizations

Authorization
string
header
required

Tolt API key sent as a bearer token.

Path Parameters

id
string
required
Example:

"part_NLYzgNKuSuASvrvoxNtau6SY"

Body

application/json
first_name
string | null

Partner's first name, part of the name shown for them unless they have a display name; null clears it.

Required string length: 1 - 150
Example:

"Sam"

last_name
string | null

Partner's family name, shown with first_name in the dashboard and partner portal; null clears it.

Required string length: 1 - 150
Example:

"Rivera"

company_name
string | null

Business the partner promotes through; null clears it.

Required string length: 1 - 255
Example:

"Acme"

country_code
string | null

Partner's country as a two-letter ISO code. Commission flows can match on it.

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

"US"

website_url
string<uri> | null

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

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

"https://acme.com"

group_id
string | null

Id of a group in the partner's program to move them to (grp_...), as returned when listing groups. Commission flows scoped to that group then apply to them; null removes them from their group.

Minimum string length: 1
Example:

"grp_1a2b3c"

Response

The updated partner

success
boolean
required
Example:

true

message
string
required
Example:

"Request successful"

data
object
required