Affiliates API
Affiliate Programs

Update Affiliate Program

This API endpoint (POST) updates an affiliate program. If the request succeeds, it returns an Affiliate Program Object; otherwise, it will return an error. Permissions: affiliate_programs.edit Webhooks: affiliate-program-updated

Path Parameters

id* The id of the affiliate program

Body Parameters

languages object * The titles and descriptions of the affiliate program in all supported languages. The minimum information required is a title in at least one language. The object's keys are a Language Codes, while the values are also objects with the content of the affiliate program.

Note: A language has to be activated on your account before it can be used.

Exampe



currency* string (currency code) The currency of the affiliate program. Once affiliates are enrolled in the affiliate program, this attribute can no longer be modified.



description * string The short description of the affiliate program.



products * array of strings An array of product ids. Commission will be credited for purchases referred by affiliates that contain at least one of these products.



commission_amount * integer The fixed commission amount credited on every sale referred by an affiliate. Once affiliates are enrolled in the affiliate program, this attribute can no longer be modified.



commission_percent * percent The commission percentage credited on every sale referred by an affiliate.Once affiliates are enrolled in the affiliate program, this attribute can no longer be modified.



payments array of strings * Payment codes The payout whitelist for the affiliate program. When set, affiliates choose any of these payment methods as a payout option.



destinations array of strings * (Country Codes) The country whitelist of the affiliate program. When set, only affiliates located in any of the provided countries can join the program. For worldwide support: ['worldwide']



is_public boolean Determines if the affiliate program is publicly visible and affiliates are allowed to join. The default value is true.



domain string * The ID of a domain to associate with the affiliate program.



auto_approve boolean Determines if affiliates that join this program are automatically approved. The default value is false.



allow_bonuses boolean Determines if affiliates can offer bonuses to customers they refer. The default value is false.



is_listed boolean Determines if the affiliate program will be listed in the public affiliate network. The default value is false.



affiliate_notifications boolean Determines if notifications will be sent to affiliates on every new sale and on every commission refunded. The default value is false.



banners array of strings An array of asset ids to associated with the affiliate program. Affiliates will be able to download and use these banners.



cookie_expiry integer The lifetime of the affiliate cookie in days. The default value is 90 days.



payout_delay integer The delay in days before a commission is credited to an affiliate. The default value is 0 days.



subscription_commission_type string The commission structure for any billing plans associated with this affiliate program. The possible values are once, forever and repeating. The default value is once. Once affiliates are enrolled in the affiliate program, this attribute can no longer be modified.



duration integer The number of payments to credit commission for any billing plans associated with this affiliate program. Required if subscription_commission_type is set to repeating. Once affiliates are enrolled in the affiliate program, this attribute can no longer be modified.