Skip to main content
PATCH
Update the affiliate settings

Authorizations

X-API-Key
string
header
required

Body

application/json

The settings an affiliate changes. Send the ones to change; at least one.

paypal_email
string<email> | null

The PayPal account payouts are sent to. Setting a different address restarts the destination hold.

Maximum string length: 320
vanity_code
string | null

The affiliate's one custom code: 4-32 lowercase letters, digits or hyphens. It is claimed once and cannot be changed after.

Required string length: 4 - 32

Response

Successful Response

What the affiliate has set for themselves: where payouts go and the custom code.

paypal_email
string | null
required

The PayPal account payouts are sent to.

paypal_email_confirmed_at
string<date-time> | null
required

When the payout email was last set; the destination hold counts from it.

vanity_code
string | null
required

The claimed custom code, when one exists.