Submit an Offer

post

https://api.banyan.com/v1/offer

Submit an offer.

Body Params

activation_window_minutes

integer

Activation_Window_Minutes is the number of minutes the offer is active after the customer had activated it.

allow_activation_after_purchase

boolean

When enabled, will allow an offer activation to occur after a purchase has already been made.

always_on

boolean

Enables the offer to be "Always On", whereby no activations are required and redemptions will be generated for all qualifying consumers from the publisher (transaction provider). Note: Allow Activation After Purchase must also be enabled when Always On is enabled.

amount_back_limit

string

length ≥ 1

The limit of amount back rewards that can be awarded on a single offer redemption. Setting to 0 will enable no limit.

amount_back_per_dollar

string

length ≥ 1

The amount of rewards awarded per qualified dollar spent on the offer.

amount_back_per_unit

string

length ≥ 1

The amount of rewards awarded per qualified unit spent purchased.

amount_back_type

string

The type of the amount back award (e.g. DOLLARS, POINTS, etc.)

budget

integer

The total amount that can be spent on this offer during the offer's lifetime.

byn_advertiser_id

integer

required

The Banyan ID for the advertiser (receipt provider) participating in the offer.

byn_campaign_id

uuid

required

The Banyan ID for the campaign this offer belongs to.

card_issuer

string

card_types

array of strings

card_types

currency

string

The currency code for amount back rewards (if in DOLLARS)

expiration_ts

date-time

The timestamp at which the offer will no longer be eligible for fulfillment.

name

string

The name of the offer given by the publisher.

offer_criteria

object

offer_hotel_criteria

object

prorate_qualified_spend

boolean

Allows the choice of overriding the default behavior to prorate qualified item spend. Default: true.

publisher_offer_id

string

required

The offer ID given by the publisher.

return_receipt_detail

boolean

Will enable the Offer Redemptions generated for this offer to include receipt details.

start_ts

date-time

The timestamp at which the offer will be eligible for fulfillment.

Responses

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The offer was created.

400The request was malformed.

401Bearer token expired or not correct.

403Partner does not have permissions for resource

408Request timeout

409The request was conflicted.

413Request body is too large (4MiB limit)

500Internal server error