Skip to main content
POST
Decline

Authorizations

Authorization
string
header
required

A client access token, issued to your Extole account and used from your own backend. Never send a client token from a consumer device.

Path Parameters

decline_event_name
enum<string>
required

The event that declines a rewardable that is waiting on review. It is named after the journey, which here is reward_core, so the event is reward_core_manual_decline. Rename the journey and this name changes with it, so take it from the declineEventName setting on the reward rather than assembling it yourself.

Available options:
reward_core_manual_decline

Body

application/json
identity_person_id
string
required

Which rewardable this is, when the reward can be earned more than once. The key is named identity_person_id on this reward, and it is how a caller says which one.

note
string
required

Why the rewardable was declined. Required: the campaign drops the event without one, so a call with no note answers with an event id and nothing happens.

person_id
string
required

Extole person whose rewardable is being declined.

target
enum<string>
required

Which campaign this applies to. Here that is campaign_id:{id}.

Available options:
campaign_id:{id}
container
string

Container the rewardable sits in, when it has one.

Response

Success

event_id
string
required

Identifier of the event. The outcome follows from the campaign rules, so read the person rewards to see it.

person_id
string
required

Extole person the event resolved to.