API Reference

Update an action

Updates the specified action by setting the values of the parameters passed. Use this endpoint to update any of the high-level details for the action such as CustomerStatus and Disposition. Note that actions can be specified either by using the impact.com's unique identifier for the action (i.e. ActionId) or by using a combination of your identifier (i.e. OrderId) and the type of event (i.e. EventType).

If you wish to reverse an action, use the reverse action endpoint. If you want to return items for this action, use the update action item endpoint.

📘

Note:

impact.com allows a maximum of 1000 modifications per action. If you need to make further modifications thereafter, contact support.

Parameters

ActionId required, unless using ActionTrackerId and OrderId together

Unique identifier for the action, used to specify which action you intend to update. 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

Submit ORDER_UPDATE as the default value for updating an action. If you have a custom disposition code configured in event type settings that modifies the action, you can submit that value instead.

CustomerStatus optional

If you've configured Customer Status Mapping in event type settings, you can pass your custom value to change the customer's status for an action (e.g., changing a customer status for a new customer, which your contract with a partner could specify a higher payout for).

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 PUT \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'ActionId=1234.5678.9101112' \ 
  -d 'DispositionCode=ORDER_UPDATE' \
  -d 'CustomerStatus=NEW'

Example Response

{
  "Status": "QUEUED",
  "QueuedUri": "/Advertisers/<AccountSID>/APISubmissions/A-4632dba3-2211-4615-a62d-6e121ddcdfa1"
}