Skip to main content

Fields

codeType : CodeType
description : String

Description of the referral code.

descriptionInSpanish : String

Description of the referral code in Spanish.

isValid : Boolean

Check if the referral code is valid.

maxRecurrence : String

Maximum number of times the code can be used.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "codeType": "REFERRAL_CODE", "description": "life-chance-candidate-education-cultural", "descriptionInSpanish": "soon-Mr-cup-investment-the", "isValid": true, "maxRecurrence": "officer-network-hospital-cultural-personal" }