> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/brand-api-reference/brand-api-reference-v11/reference/actions/actions.md).
# Actions
## List all actions
> Returns a list of the actions your campaign has recorded. Actions are returned by creation date, with the most recently created actions appearing first.
```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v11"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"Action":{"type":"object","description":"Represents a conversion event credited to a partner.","properties":{"Id":{"type":"string","description":"Unique impact.com identifier for the action."},"CampaignId":{"type":"integer","description":"Unique identifier for the campaign (program) this action belongs to."},"CampaignName":{"type":"string","description":"Display name of the campaign."},"ActionTrackerId":{"type":"integer","description":"Unique identifier for the action tracker (event type) that recorded this action."},"ActionTrackerName":{"type":"string","description":"Display name of the action tracker (event type)."},"MediaPartnerId":{"type":"integer","description":"Unique identifier for the partner credited for this action."},"MediaPartnerName":{"type":"string","description":"Display name of the credited partner."},"State":{"type":"string","description":"Current state of the action.\n- `PENDING`: Awaiting locking date or manual approval. Actions that have been modified also carry this state.\n- `APPROVED`: Reached its locking date or was manually approved. Will pay out the partner. No further modifications permitted.\n- `REVERSED`: Was reversed and will not pay out the partner.\n","enum":["PENDING","APPROVED","REVERSED"]},"AdId":{"type":"integer","description":"Unique identifier for the ad creative that drove the winning click."},"Payout":{"type":"number","description":"Commission amount to be paid to the partner, in the currency specified by the `Currency` field."},"Amount":{"type":"number","description":"Revenue amount associated with the action (sale amount), in the currency specified by the `Currency` field."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code for monetary values in this action."},"EventDate":{"type":"string","format":"date-time","description":"Timestamp of when the conversion event occurred."},"Oid":{"type":"string","description":"Your unique identifier for the order associated with this action."},"CustomerId":{"type":"string","description":"Your unique, non-PII identifier for the customer who made the conversion."},"Uri":{"type":"string","description":"Unique URI reference to this action object."}}}}},"paths":{"/Advertisers/{AccountSID}/Actions":{"get":{"operationId":"listActions","tags":["Actions"],"summary":"List all actions","description":"Returns a list of the actions your campaign has recorded. Actions are returned by creation date, with the most recently created actions appearing first.","parameters":[{"name":"AccountSID","in":"path","required":true,"description":"Your unique account identifier.","schema":{"type":"string"}},{"name":"CampaignId","in":"query","required":true,"description":"The ID of the campaign (program) to list actions for.","schema":{"type":"string"}},{"name":"State","in":"query","description":"Filters actions based on their current state.","schema":{"type":"string","enum":["PENDING","APPROVED","REVERSED"]}},{"name":"StartDate","in":"query","description":"Filters for actions with a last updated date on or after this value (ISO 8601 with time component).\nMust be used together with EndDate. Cannot be more than 3 years in the past, and the range with EndDate cannot exceed 45 days.\n","schema":{"type":"string","format":"date-time"}},{"name":"EndDate","in":"query","description":"Filters for actions with a last updated date on or before this value (ISO 8601 with time component).\nMust be used together with StartDate.\n","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"An array of action objects.","content":{"application/json":{"schema":{"type":"object","properties":{"Actions":{"type":"array","items":{"$ref":"#/components/schemas/Action"}}}}}}}}}}}}
```
## Update an action or item
> Updates the specified action by setting the values of the parameters passed.\
> Use this endpoint to update high-level action details such as \`CustomerStatus\`.\
> \
> The action can be identified either by \`ActionId\`, or by the combination of \`ActionTrackerId\` and \`OrderId\`.\
> \
> Note: impact.com allows a maximum of 1,000 modifications per action.
```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v11"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"QueuedResponse":{"type":"object","description":"Returned when a modification or reversal request has been accepted and queued for processing.","properties":{"Status":{"type":"string","description":"Indicates the status of the request. A successful submission returns `QUEUED`."},"QueuedUri":{"type":"string","description":"The URI of the API submission record, which can be used to track the status of the queued request."}}}}},"paths":{"/Advertisers/{AccountSID}/Actions":{"put":{"operationId":"updateAction","tags":["Actions"],"summary":"Update an action or item","description":"Updates the specified action by setting the values of the parameters passed.\nUse this endpoint to update high-level action details such as `CustomerStatus`.\n\nThe action can be identified either by `ActionId`, or by the combination of `ActionTrackerId` and `OrderId`.\n\nNote: impact.com allows a maximum of 1,000 modifications per action.\n","parameters":[{"name":"AccountSID","in":"path","required":true,"description":"Your unique account identifier.","schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"ActionId":{"type":"string","description":"Unique identifier for the action. Required unless using ActionTrackerId and OrderId together."},"ActionTrackerId":{"type":"integer","description":"Unique identifier for the action tracker (event type). Required with OrderId if ActionId is not used."},"OrderId":{"type":"string","description":"Your unique order identifier. Required with ActionTrackerId if ActionId is not used."},"DispositionCode":{"type":"string","description":"Submit `ORDER_UPDATE` as the default value for updating an action. Custom disposition codes may also be used if configured.","default":"ORDER_UPDATE"},"CustomerStatus":{"type":"string","description":"A new custom status for the customer associated with the action (e.g., `NEW`, `EXISTING`)."},"Sku":{"type":"string","description":"The SKU of the line item to update. For bulk updates use indexed params (Sku, Sku2, Sku3, etc.)."},"Quantity":{"type":"integer","description":"The new absolute quantity for the item. For bulk updates use indexed params (Quantity, Quantity2, etc.)."},"Amount":{"type":"number","description":"The new total sale amount for the order or item. Setting to 0 on a tracked action with a non-zero amount will reverse the action."},"Reason":{"type":"string","description":"Required. A valid reason code for the modification. Default reason codes:\n`ORDER_UPDATE`, `ITEM_RETURNED`, `CONS_FRAUD`, `CONS_ERROR`, `ORDER_ERROR`,\n`PUB_ACT_DISPUTE`, `ADV_ACT_DISPUTE`, `NOT_COMPLIANCE_TERMS`,\n`ITEM_OUT_OF_STOCK`, `TEST_ACTION`, `PARTNER_NOT_ACTIVE`,\n`CREDITED_DIFFERENT_MP`, `OTHER`.\n"}}}}}},"responses":{"200":{"description":"Request queued successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueuedResponse"}}}}}}}}}
```
## Reverse an action
> Reverses an action, cancelling any pending payouts to partners.\
> \
> The action can be identified either by \`ActionId\`, or by the combination of \`ActionTrackerId\` and \`OrderId\`.
```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v11"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"QueuedResponse":{"type":"object","description":"Returned when a modification or reversal request has been accepted and queued for processing.","properties":{"Status":{"type":"string","description":"Indicates the status of the request. A successful submission returns `QUEUED`."},"QueuedUri":{"type":"string","description":"The URI of the API submission record, which can be used to track the status of the queued request."}}}}},"paths":{"/Advertisers/{AccountSID}/Actions":{"delete":{"operationId":"reverseAction","tags":["Actions"],"summary":"Reverse an action","description":"Reverses an action, cancelling any pending payouts to partners.\n\nThe action can be identified either by `ActionId`, or by the combination of `ActionTrackerId` and `OrderId`.\n","parameters":[{"name":"AccountSID","in":"path","required":true,"description":"Your unique account identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["DispositionCode"],"properties":{"ActionId":{"type":"string","description":"Unique identifier for the action to reverse. Required unless using ActionTrackerId and OrderId together."},"ActionTrackerId":{"type":"integer","description":"Unique identifier for the action tracker (event type). Required with OrderId if ActionId is not used."},"OrderId":{"type":"string","description":"Your unique order identifier. Required with ActionTrackerId if ActionId is not used."},"DispositionCode":{"type":"string","description":"Required. A valid code explaining the reason for the reversal.","enum":["REJECTED","CONS_INFO_INVALID","CONS_ERROR","CONS_FRAUD","ITEM_RETURNED","ITEM_OUT_OF_STOCK","ORDER_ERROR","PUB_ACT_DISPUTE","NOT_COMPLIANCE_TERMS","MP_RETURNED","OTHER","CREDITED_DIFFERENT_MP","ADV_ACT_DISPUTE","TEST_ACTION"]}}}}}},"responses":{"200":{"description":"Reversal queued successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueuedResponse"}}}}}}}}}
```
## Retrieve an action
> Retrieves the details of an existing action using its unique ActionId.
```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v11"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"Action":{"type":"object","description":"Represents a conversion event credited to a partner.","properties":{"Id":{"type":"string","description":"Unique impact.com identifier for the action."},"CampaignId":{"type":"integer","description":"Unique identifier for the campaign (program) this action belongs to."},"CampaignName":{"type":"string","description":"Display name of the campaign."},"ActionTrackerId":{"type":"integer","description":"Unique identifier for the action tracker (event type) that recorded this action."},"ActionTrackerName":{"type":"string","description":"Display name of the action tracker (event type)."},"MediaPartnerId":{"type":"integer","description":"Unique identifier for the partner credited for this action."},"MediaPartnerName":{"type":"string","description":"Display name of the credited partner."},"State":{"type":"string","description":"Current state of the action.\n- `PENDING`: Awaiting locking date or manual approval. Actions that have been modified also carry this state.\n- `APPROVED`: Reached its locking date or was manually approved. Will pay out the partner. No further modifications permitted.\n- `REVERSED`: Was reversed and will not pay out the partner.\n","enum":["PENDING","APPROVED","REVERSED"]},"AdId":{"type":"integer","description":"Unique identifier for the ad creative that drove the winning click."},"Payout":{"type":"number","description":"Commission amount to be paid to the partner, in the currency specified by the `Currency` field."},"Amount":{"type":"number","description":"Revenue amount associated with the action (sale amount), in the currency specified by the `Currency` field."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code for monetary values in this action."},"EventDate":{"type":"string","format":"date-time","description":"Timestamp of when the conversion event occurred."},"Oid":{"type":"string","description":"Your unique identifier for the order associated with this action."},"CustomerId":{"type":"string","description":"Your unique, non-PII identifier for the customer who made the conversion."},"Uri":{"type":"string","description":"Unique URI reference to this action object."}}}}},"paths":{"/Advertisers/{AccountSID}/Actions/{ActionId}":{"get":{"operationId":"getActionById","tags":["Actions"],"summary":"Retrieve an action","description":"Retrieves the details of an existing action using its unique ActionId.","parameters":[{"name":"AccountSID","in":"path","required":true,"description":"Your unique account identifier.","schema":{"type":"string"}},{"name":"ActionId","in":"path","required":true,"description":"The unique impact.com identifier for the action.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns an action object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Action"}}}}}}}}}
```
## List all items for an action
> Returns a list of the items within the specified action. The items are returned in the order they were originally recorded. All actions contain at least one item.
```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v11"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"ActionItem":{"type":"object","description":"Represents a single line item within an action.","properties":{"Sku":{"type":"string","description":"Stock-keeping unit (SKU) or product identifier for the item."},"ItemName":{"type":"string","description":"Display name of the product."},"Category":{"type":"string","description":"Product category for the item."},"Quantity":{"type":"string","description":"Number of units of this product in the order."},"SaleAmount":{"type":"string","description":"Revenue amount for this line item."},"Payout":{"type":"number","description":"Commission amount for this line item."},"Uri":{"type":"string","description":"Unique URI reference to this action item object."}}}}},"paths":{"/Advertisers/{AccountSID}/Actions/{ActionId}/Items":{"get":{"operationId":"listActionItems","tags":["Actions"],"summary":"List all items for an action","description":"Returns a list of the items within the specified action. The items are returned in the order they were originally recorded. All actions contain at least one item.","parameters":[{"name":"AccountSID","in":"path","required":true,"description":"Your unique account identifier.","schema":{"type":"string"}},{"name":"ActionId","in":"path","required":true,"description":"The unique impact.com identifier for the action.","schema":{"type":"string"}}],"responses":{"200":{"description":"An array of action item objects.","content":{"application/json":{"schema":{"type":"object","properties":{"ActionItems":{"type":"array","items":{"$ref":"#/components/schemas/ActionItem"}}}}}}}}}}}}
```
## Retrieve an item from an action
> Retrieves the details of a specific line item within an action, identified by ActionId and SKU.
```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v11"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"ActionItem":{"type":"object","description":"Represents a single line item within an action.","properties":{"Sku":{"type":"string","description":"Stock-keeping unit (SKU) or product identifier for the item."},"ItemName":{"type":"string","description":"Display name of the product."},"Category":{"type":"string","description":"Product category for the item."},"Quantity":{"type":"string","description":"Number of units of this product in the order."},"SaleAmount":{"type":"string","description":"Revenue amount for this line item."},"Payout":{"type":"number","description":"Commission amount for this line item."},"Uri":{"type":"string","description":"Unique URI reference to this action item object."}}}}},"paths":{"/Advertisers/{AccountSID}/Actions/{ActionId}/Items/{Sku}":{"get":{"operationId":"getActionItemBySku","tags":["Actions"],"summary":"Retrieve an item from an action","description":"Retrieves the details of a specific line item within an action, identified by ActionId and SKU.","parameters":[{"name":"AccountSID","in":"path","required":true,"description":"Your unique account identifier.","schema":{"type":"string"}},{"name":"ActionId","in":"path","required":true,"description":"The unique impact.com identifier for the action.","schema":{"type":"string"}},{"name":"Sku","in":"path","required":true,"description":"The SKU or product identifier for the item.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns an action item object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionItem"}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://integrations.impact.com/brand-api-reference/brand-api-reference-v11/reference/actions/actions.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.