Create a new referral_code

post/v1/referral_codes/

Request

Headers

App-IDstring required
Auth-Tokenstring required

Request body

billing_tier'PAYGO' | 'PRO' | 'ENTERPRISE' | 'ENTERPRISE_LEGACY_2025' | 'PRO_LEGACY_2025' nullable
codestring required
credit_expiry_daysinteger nullable
do_not_deleteboolean nullable
freeze_datestring date-time nullable
is_plgboolean nullable
manage_system_domain_idstring uuid nullable
ordway_customer_idstring nullable
sales_force_idstring nullable
valid_tostring date-time required
valuenumber required

Response

Returns a created referral_code

billing_tier'PAYGO' | 'PRO' | 'ENTERPRISE' | 'ENTERPRISE_LEGACY_2025' | 'PRO_LEGACY_2025' nullable
codestring required
credit_expiry_daysinteger nullable
do_not_deleteboolean nullable
freeze_datestring date-time nullable
is_plgboolean nullable
manage_system_domain_idstring uuid nullable
ordway_customer_idstring nullable
sales_force_idstring nullable
valid_tostring date-time required
valuenumber required

Changes

No recorded changes to this operation across all 1 revision of this API.