REST RPC APIRetention Incentives

Create retention incentives for a customer

View as Markdown

Create the provided eligible retention incentives for a given customer;

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

OR
authorizationstring

Storefront API Scope — client-side, scoped to one customer, sent as a signature in the authorization header. See Authentication.

Request

This endpoint expects an object.
merchant_user_idstringOptional

The external ID of the customer for whom to retrieve the eligibility evaluation. This field is required for non-customer-level authentication and is not supported for customer-level authentication.

retention_incentives_to_createlist of objectsOptional

List of retention incentives to create for the customer;

Response

200
merchant_user_idstringOptional
retention_incentiveslist of objectsOptional

Errors

400
Bad Request Error