The 'organisationId' field is deprecated.

Please use 'organisationNumber' instead.

- Marked as deprecated on 2026-03-03.
- Scheduled for removal on or after 2026-06-01.

organisationNumber : String

Optional number of the affiliate organisation.

referralCode : String

The referral code used by the customer when signing up.

salesChannel : String

Sales channel.

salesSubchannel : String

Sales subchannel.

Deprecation

The 'salesSubchannel' field is deprecated.

Please use affiliateSessionId to provide custom sales info, or log in with the correct Organisation.

- Marked as deprecated on 2024-10-17.
- Scheduled for removal on or after 2024-12-01.

urn : String

Unique reference number.

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

{
  "affiliateSessionId": "45773782",
  "offerGroupIdentifier": "22939273",
  "organisationNumber": "study-usually-gas-think-reach",
  "referralCode": "machine-world-doctor-rise-be",
  "salesChannel": "college-treat-defense-service-outside",
  "urn": "subject-happy-future-fact-test"
}