> 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-v12/reference/actions/actions.md).
# Actions
## List 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.\
> \
> \*\*Date filtering constraints (effective 5 August 2024):\*\*\
> \- \`StartDate\` cannot be more than 3 years in the past.\
> \- The range between \`StartDate\` and \`EndDate\` cannot exceed 45 days.\
> \- If neither \`StartDate\` nor \`EndDate\` is specified, only the past 7 days are returned.\
> \- If \`StartDate\` is specified, \`EndDate\` must also be specified.\
> \- Default page size is 20,000 records. Minimum page size is 2,000.\
> \- If the total record count exceeds 10× the page size, an error is returned — reduce the date range or increase PageSize.
```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v12"},"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)."},"EventCode":{"type":"string","description":"The event code associated with the action tracker, if configured."},"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. Modified actions also carry this state.\n- `APPROVED`: Reached its locking date or was manually approved. Will pay out the partner.\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."},"ClientCost":{"type":"number","description":"The total cost to the brand for this action (payout plus any fees)."},"Payout":{"type":"number","description":"Commission amount to be paid to the partner."},"DeltaPayout":{"type":"number","description":"The change in payout value from the most recent modification. Equals Payout for unmodified actions."},"IntendedPayout":{"type":"number","description":"The originally intended payout before any modifications."},"Amount":{"type":"number","description":"Revenue amount (sale amount) associated with this action."},"DeltaAmount":{"type":"number","description":"The change in sale amount from the most recent modification. Equals Amount for unmodified actions."},"IntendedAmount":{"type":"number","description":"The originally intended sale amount before any modifications."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code for monetary values in this action."},"ReferringDate":{"type":"string","format":"date-time","description":"Timestamp of the winning click that led to this conversion."},"EventDate":{"type":"string","format":"date-time","description":"Timestamp of when the conversion event occurred."},"CreationDate":{"type":"string","format":"date-time","description":"Timestamp of when this action record was created in impact.com."},"LockingDate":{"type":"string","format":"date-time","description":"Date after which the action can no longer be modified. Once passed, a Pending action moves to Approved."},"ClearedDate":{"type":"string","format":"date-time","nullable":true,"description":"Date when the commission for this action was cleared and paid out. Empty if not yet cleared."},"ReferringType":{"type":"string","description":"The type of referral that drove the winning click (e.g., `CLICK_COOKIE`, `CLICK_FINGERPRINT`)."},"ReferringDomain":{"type":"string","description":"Domain of the website where the winning click occurred. May be empty."},"PromoCode":{"type":"string","description":"Promotional code applied during the conversion, if any."},"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."},"CustomerStatus":{"type":"string","description":"A custom status label for the customer, as defined in your event type settings (e.g., `NEW`, `EXISTING`)."},"CustomerPostCode":{"type":"string","description":"Postal code of the customer, if passed at conversion time."},"CustomerArea":{"type":"string","description":"Area or neighbourhood of the customer, if passed at conversion time."},"CustomerCity":{"type":"string","description":"City of the customer, if passed at conversion time."},"CustomerRegion":{"type":"string","description":"State or region of the customer, if passed at conversion time."},"CustomerCountry":{"type":"string","description":"Two-letter ISO country code for the customer's country, if passed at conversion time."},"IpAddress":{"type":"string","description":"Hashed IP address of the customer at the time of conversion."},"SharedId":{"type":"string","description":"The Shared ID value passed from the winning click, used for cross-device or cross-channel attribution."},"CallerId":{"type":"string","description":"Caller ID associated with the action, used in call tracking integrations."},"Note":{"type":"string","description":"Free-text note attached to the action, if any."},"Uri":{"type":"string","description":"Unique URI reference to this action object."}}}}},"paths":{"/Advertisers/{AccountSID}/Actions":{"get":{"summary":"List actions","description":"Returns a list of the actions your campaign has recorded. Actions are returned by creation date,\nwith the most recently created actions appearing first.\n\n**Date filtering constraints (effective 5 August 2024):**\n- `StartDate` cannot be more than 3 years in the past.\n- The range between `StartDate` and `EndDate` cannot exceed 45 days.\n- If neither `StartDate` nor `EndDate` is specified, only the past 7 days are returned.\n- If `StartDate` is specified, `EndDate` must also be specified.\n- Default page size is 20,000 records. Minimum page size is 2,000.\n- If the total record count exceeds 10× the page size, an error is returned — reduce the date range or increase PageSize.\n","operationId":"listActions","tags":["Actions"],"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":"integer"}},{"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. Note: state transitions (e.g., Pending → Approved) do not count as updates.\nConsider using LockingDateStart if you want to filter by approval date.\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"}},{"name":"ActionDateStart","in":"query","description":"Filters for actions with an EventDate on or after this value (ISO 8601 with time component). Can be used as an alternative to StartDate.","schema":{"type":"string","format":"date-time"}},{"name":"ActionDateEnd","in":"query","description":"Filters for actions with an EventDate on or before this value (ISO 8601 with time component). Must be used with ActionDateStart.","schema":{"type":"string","format":"date-time"}},{"name":"LockingDateStart","in":"query","description":"Filters for actions with a LockingDate on or after this value (ISO 8601 with time component).","schema":{"type":"string","format":"date-time"}},{"name":"LockingDateEnd","in":"query","description":"Filters for actions with a LockingDate on or before this value (ISO 8601 with time component). Must be used with LockingDateStart.","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 its items
> Updates an action or its line items. The action can be identified either by \`ActionId\`,\
> or by a combination of \`ActionTrackerId\` and \`OrderId\`.\
> \
> \- To update an action's metadata (e.g., \`CustomerStatus\`), provide \`ActionId\` and \`DispositionCode\`.\
> \- To update one or more items within an action, provide \`ActionId\`, \`Sku\`, and item-specific fields.\
> \
> Note: impact.com allows a maximum of 1,000 modifications per action.
```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v12"},"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":{"summary":"Update an action or its items","description":"Updates an action or its line items. The action can be identified either by `ActionId`,\nor by a combination of `ActionTrackerId` and `OrderId`.\n\n- To update an action's metadata (e.g., `CustomerStatus`), provide `ActionId` and `DispositionCode`.\n- To update one or more items within an action, provide `ActionId`, `Sku`, and item-specific fields.\n\nNote: impact.com allows a maximum of 1,000 modifications per action.\n","operationId":"updateActionOrItems","tags":["Actions"],"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."},"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.)."},"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"},"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."},"Category":{"type":"string","description":"The product category for the action item."},"ItemName":{"type":"string","description":"The display name of the action item."},"Rebate":{"type":"number","description":"A discount or rebate amount to apply to the action item."},"ItemSubTotalDelta":{"type":"number","description":"A relative delta amount to add or subtract from the item's SaleAmount. Use instead of Amount for partial adjustments."}}}}}},"responses":{"200":{"description":"Request has been queued for processing.","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 a combination of \`ActionTrackerId\` and \`OrderId\`.
```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v12"},"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":{"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 a combination of `ActionTrackerId` and `OrderId`.\n","operationId":"reverseAction","tags":["Actions"],"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. Changes the action status to REVERSED.","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":"Request has been queued for processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueuedResponse"}}}}}}}}}
```
## Get action by ID
> Retrieves the details of an existing action by its unique impact.com ActionId.
```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v12"},"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)."},"EventCode":{"type":"string","description":"The event code associated with the action tracker, if configured."},"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. Modified actions also carry this state.\n- `APPROVED`: Reached its locking date or was manually approved. Will pay out the partner.\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."},"ClientCost":{"type":"number","description":"The total cost to the brand for this action (payout plus any fees)."},"Payout":{"type":"number","description":"Commission amount to be paid to the partner."},"DeltaPayout":{"type":"number","description":"The change in payout value from the most recent modification. Equals Payout for unmodified actions."},"IntendedPayout":{"type":"number","description":"The originally intended payout before any modifications."},"Amount":{"type":"number","description":"Revenue amount (sale amount) associated with this action."},"DeltaAmount":{"type":"number","description":"The change in sale amount from the most recent modification. Equals Amount for unmodified actions."},"IntendedAmount":{"type":"number","description":"The originally intended sale amount before any modifications."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code for monetary values in this action."},"ReferringDate":{"type":"string","format":"date-time","description":"Timestamp of the winning click that led to this conversion."},"EventDate":{"type":"string","format":"date-time","description":"Timestamp of when the conversion event occurred."},"CreationDate":{"type":"string","format":"date-time","description":"Timestamp of when this action record was created in impact.com."},"LockingDate":{"type":"string","format":"date-time","description":"Date after which the action can no longer be modified. Once passed, a Pending action moves to Approved."},"ClearedDate":{"type":"string","format":"date-time","nullable":true,"description":"Date when the commission for this action was cleared and paid out. Empty if not yet cleared."},"ReferringType":{"type":"string","description":"The type of referral that drove the winning click (e.g., `CLICK_COOKIE`, `CLICK_FINGERPRINT`)."},"ReferringDomain":{"type":"string","description":"Domain of the website where the winning click occurred. May be empty."},"PromoCode":{"type":"string","description":"Promotional code applied during the conversion, if any."},"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."},"CustomerStatus":{"type":"string","description":"A custom status label for the customer, as defined in your event type settings (e.g., `NEW`, `EXISTING`)."},"CustomerPostCode":{"type":"string","description":"Postal code of the customer, if passed at conversion time."},"CustomerArea":{"type":"string","description":"Area or neighbourhood of the customer, if passed at conversion time."},"CustomerCity":{"type":"string","description":"City of the customer, if passed at conversion time."},"CustomerRegion":{"type":"string","description":"State or region of the customer, if passed at conversion time."},"CustomerCountry":{"type":"string","description":"Two-letter ISO country code for the customer's country, if passed at conversion time."},"IpAddress":{"type":"string","description":"Hashed IP address of the customer at the time of conversion."},"SharedId":{"type":"string","description":"The Shared ID value passed from the winning click, used for cross-device or cross-channel attribution."},"CallerId":{"type":"string","description":"Caller ID associated with the action, used in call tracking integrations."},"Note":{"type":"string","description":"Free-text note attached to the action, if any."},"Uri":{"type":"string","description":"Unique URI reference to this action object."}}}}},"paths":{"/Advertisers/{AccountSID}/Actions/{ActionId}":{"get":{"summary":"Get action by ID","description":"Retrieves the details of an existing action by its unique impact.com ActionId.","operationId":"getActionById","tags":["Actions"],"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 action object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Action"}}}}}}}}}
```
## List action items
> 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":"v12"},"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."},"SaleAmountCurrency":{"type":"string","description":"Three-letter ISO 4217 currency code for the sale amount."},"Payout":{"type":"number","description":"Commission amount for this line item."},"PayoutCurrency":{"type":"string","description":"Three-letter ISO 4217 currency code for the payout amount."},"Rebate":{"type":"number","description":"Discount or rebate amount applied to this item."},"RebateCurrency":{"type":"string","description":"Three-letter ISO 4217 currency code for the rebate amount."},"AdjustmentDate":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp of the most recent adjustment to this item. Empty if the item has not been modified."},"AdjustmentReason":{"type":"string","description":"The reason code for the most recent adjustment to this item."},"Uri":{"type":"string","description":"Unique URI reference to this action item object."}}}}},"paths":{"/Advertisers/{AccountSID}/Actions/{ActionId}/Items":{"get":{"summary":"List action items","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.","operationId":"listActionItems","tags":["Actions"],"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"}}}}}}}}}}}}
```
## Get action item by SKU
> 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":"v12"},"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."},"SaleAmountCurrency":{"type":"string","description":"Three-letter ISO 4217 currency code for the sale amount."},"Payout":{"type":"number","description":"Commission amount for this line item."},"PayoutCurrency":{"type":"string","description":"Three-letter ISO 4217 currency code for the payout amount."},"Rebate":{"type":"number","description":"Discount or rebate amount applied to this item."},"RebateCurrency":{"type":"string","description":"Three-letter ISO 4217 currency code for the rebate amount."},"AdjustmentDate":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp of the most recent adjustment to this item. Empty if the item has not been modified."},"AdjustmentReason":{"type":"string","description":"The reason code for the most recent adjustment to this item."},"Uri":{"type":"string","description":"Unique URI reference to this action item object."}}}}},"paths":{"/Advertisers/{AccountSID}/Actions/{ActionId}/Items/{Sku}":{"get":{"summary":"Get action item by SKU","description":"Retrieves the details of a specific line item within an action, identified by ActionId and SKU.","operationId":"getActionItemBySku","tags":["Actions"],"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":"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-v12/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.