v1

latestOpenAPI 3.0.12026-08-062532117.6 KB

Update an affiliate

Updates an affiliate identified by affiliateId or emailAddress.

This endpoint returns a count of updated records, not the affiliate object. Call Get Affiliate(s) afterwards if you need the updated affiliate.

Sending affiliateLink adds another referral link to the affiliate — it does not rename or replace existing links. Use the affiliate link endpoints to rename or remove a link.

put/affiliates

Request body

affiliateIdstring

The ID of the affiliate (required if emailAddress is not provided)

emailAddressstring email

The email of the affiliate (required if affiliateId is not provided)

firstNamestring

First name of the affiliate

lastNamestring

Last name of the affiliate

emailstring email

Email of the affiliate

commissionRatenumber float

Commission rate for the affiliate

affiliateStatus'active' | 'inactive'

Set the affiliate active or pending. Any other value falls back to the program's auto-approve setting.

affiliateLinkstring

Adds an additional referral link with this slug. Existing links are kept — this never renames or replaces them. Fails with 400 if the slug is already used in this program.

Response

The number of affiliate records that matched and were updated. count is 0 when no affiliate in this program matched.

countinteger

How many records matched the filter and were updated

Example response

{
  "count": 1
}