Help Center

| Submit or View Help Requests | Developer Docs |
| |

Batch Process Reversals via API (Web Services) Overview

If anything about an action changes (e.g., an order was canceled, an item was returned, etc.), you can use the API to modify (or reverse) it, changing the commission amount for the action. In this article, we'll show how to modify and reverse an action with cURL calls to the Brand API.

Batch process reversal options

  • Modify or reverse one or more items in an action via API

  • Reverse an entire action via API

Prerequisite: Retrieve the ActionId value

To reverse an action, you'll need its ActionId value. The call below will retrieve all actions for a specified Program (i.e., Campaign) — you can use this to find the action you want to modify.


View the List all actions API endpoint documentation to learn more. You can specify a date range in your call — otherwise, the endpoint defaults to showing the last 30 days of actions. Rate limits apply.

Example call

curl '{AccountSID}/Actions' \  -X GET \  -u '{AccountSID}:{AuthToken}' \  -H 'Accept: application/json' \  -d 'CampaignId={CampaignId}'
Parameter reference


Your account's API account ID value. Learn how to find this value.


Your account's API authorization token value. Learn how to find this value.


The ID value of the program (campaign) that the action was tracked under.


Example response

{  "@page": "1",  ...,  "Actions": [    {      "Id": "1000.4636.158133",      ...,    }  ]}


How do I reset a modification or reversal made to an action (or action items)?

If an action has been modified or reversed before its locking date, you can submit RESET as a reason to update the action back to its default state.


Actions that have been reset via the RESET code may not appear correctly in reporting (e.g., revenue values may be calculated incorrectly).

For a given ActionId, submit RESET as the reason to return it to its default state.

curl '{AccountSID}/Actions' \  -X PUT \  -u '{AccountSID}:{AuthToken}' \  -H 'Accept: application/json' \  -H 'Content-Type: application/x-www-form-urlencoded' \  -d 'ActionId={ActionId}' \  -d 'Reason=RESET'

What are the differences between a Disposition Code and a Reason?

Both Reasons and Disposition Codes are used in the same context — Reasons are predefined codes that the API will accept by default, whereas Disposition Codes are custom reasons you can configure. Learn more about Disposition Codes.

Default reason codes

Submitting any of these values as a reason will reverse the item (or action).




Consumer fraud


Consumer error


Item returned


Order error


Order was updated


Partner activity dispute


Advertiser activity dispute


Not in compliance with terms


Item is out of stock


Test action


Partner account deactivated


Credited to another partner


Other reason


Item in order was cancelled

How can I see when modifications (or reversals) have been applied to an action?

You can use the action updates endpoint to see when an action was last updated and what its current state is.

curl '{AccountSID}/ActionUpdates/{ActionUpdatesId}' \  -X GET \  -u '{AccountSID}:{AuthToken}' \  -H 'Accept: application/json' \


An ActionUpdatesID value is different from an ActionId value — you must use the action updates ID value to retrieve updates for an action.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.