Sign in

Referrals Configurations

This API retrieves the referral configuration, including customer and friend rewards, as well as metadata related to the events that trigger referral rewards.

get/api/v4.0/integrations/configurations/referrals

Headers

langstring

If the lang header is provided, the response will be returned in the specified language (e.g., en for English, fr for French). If this header is not included, the system will use the default language.

Response

Referral settings retrieved successfully

referralMethodstring

This specifies who will receive the referral reward when a successful referral is made. Possible values: CustomerOnly (Only the customer making the referral will receive the reward. The referred friend will not receive any reward), CustomerAndFriend (Both the customer making the referral and the referred friend will receive rewards, encouraging mutual benefit).

eventNamestring

This describes the event that will trigger the referral reward. Example: if the eventName is set to place_order, the referral reward will be granted when the referred friend completes an order after using the referral link. Other events can also be configured to trigger the reward, depending on your system's setup.

Changes

Changed in 3 of the 38 revisions of this API.168

  • 8f6120fdd12d67See the full diff
    • ●

      removed the optional property enabled from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property expirationDays from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property minimumReferrals from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property refereeReward from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property referralCodeLength from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property referrerReward from the response with the 200 status

      response-optional-property-removed

    • ○

      api operation id getReferralsConfigurations was added

      api-operation-id-added

    • ○

      added the new optional header request parameter lang

      new-optional-request-parameter

    • ○

      added the optional property customerReward to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property eventMetaData to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property eventName to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property friendReward to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property referralMethod to the response with the 200 status

      response-optional-property-added

  • 1ef1de7fdc611See the full diff
    • ○

      endpoint added

      endpoint-added

  • 919eb7a392aa1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 38 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog