Skip to navigation
REST RPC APIRetention Incentives

Retrieve Eligibility Rule

View as Markdown
Returns a single retention incentive eligibility rule by its unique public id

Authentication

x-api-keystring
API Key authentication via header

Path parameters

public_idstringRequiredDefaults to Id of the eligibility rule

Response

200
public_idstringOptional
namestringOptional
merchantstringOptional
livebooleanOptionalDefaults to true
min_days_since_last_claimintegerOptionalDefaults to 0
min_subscriber_orders_since_last_claimintegerOptionalDefaults to 0
incentive_templateslist of objectsOptional

Errors

404
Not Found Error