API Reference

Reverse an action

Use the DELETE verb to reverse an action, which will cancel payouts that partner(s) would receive for the action.

This differs from updating an action and updating individual items in an action, which changes data (such as the payout amount, or an item quantity) in an action.

Parameters

ActionId required, unless using ActionTrackerId and OrderId together

Unique identifier for the action, used to specify which action you intend to reverse. Passing the ActionId can be used instead of sending ActionTrackerId and OrderId.

ActionTrackerId optional if using ActionId, required with OrderId

Unique identifier for the action tracker (or event type) that tracked the action.

OrderId optional if using ActionId, required if using ActionTrackerId

Your unique identifier for the order ID associated with the conversion in the action.

DispositionCode required

When reversing an action, a disposition code must be submitted that includes a reason for why the action was reversed, and changes the action status to REJECTED. If you have a custom disposition code configured to reject an action, submit your custom code value.

Below are the default disposition codes we provide; submitting one of these changes the action status to rejected:

Possible enum values
REJECTED General code for reversing an action.
CONS_INFO_INVALID Indicates the consumer information in the order was invalid.
CONS_ERROR Indicates a consumer encountered an error with the order.
CONS_FRAUD Indicates consumer fraud was detected for the order.
ITEM_RETURNED Indicates the item(s) in the order were returned.
ITEM_OUT_OF_STOCK Indicates the item(s) in the order were out of stock.
ORDER_ERROR Indicates an error occurred with the order.
PUB_ACT_DISPUTE Partner activity that drove this action is disputed.
NOT_COMPLIANCE_TERMS Action didn't comply with the agreed contract with the partner.
MP_RETURNED Indicates the partner reversed the action; more common in lead generation scenarios.
OTHER Indicates the action was reversed for other reasons.
CREDITED_DIFFERENT_MP Another partner was credited for the action.
ADV_ACT_DISPUTE Activity of the advertiser (brand) is disputed.
TEST_ACTION Used for testing purposes–automatically rejects the action.

Returns

The status of the request made and the URI of the API submission object.

Example request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Actions' \
  -X DELETE \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'ActionId=1234.5678.9101112' \
  -d 'DispositionCode=REJECTED'

Example response

{
  "Status": "QUEUED",
  "QueuedUri": "/Advertisers/<AccountSID>/APISubmissions/A-f1534308-e731-4146-86b9-56992f50eefe"
}