Action Inquiries

List all action inquiries

get

Returns a list of the action inquiries made for your campaign, ordered by creation date (newest first).

Path parameters

AccountSIDstringRequired

Query parameters

CampaignIdstringRequired

StartDatestring · date-timeOptional

Filter inquiries created on or after this date (ISO 8601).

EndDatestring · date-timeOptional

Filter inquiries created on or before this date (ISO 8601).

TransactionDateStartstring · date-timeOptional

TransactionDateEndstring · date-timeOptional

MediaPartnerIdstringOptional

OrderIdstringOptional

ResolutionStatusstring · enumOptionalPossible values:

Responses

200

An array of action inquiry objects.

application/json

@pagestringOptional

get/Advertisers/{AccountSID}/ActionInquiries

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/ActionInquiries?CampaignId=text HTTP/1.1
Host: api.impact.com
Accept: */*

200

An array of action inquiry objects.

{
  "@page": "text",
  "ActionInquiries": [
    {
      "Id": "778987",
      "CampaignId": "1000",
      "CampaignName": "Acme Campaign",
      "MediaPartnerId": "10000",
      "MediaPartnerName": "Acme Partner",
      "OrderId": "9234918172372",
      "TransactionDate": "2020-09-10T00:00:00-07:00",
      "TransactionAmount": "14.00",
      "InquiryType": "UNTRACKED",
      "ExpectedPayout": "3.00",
      "ResolutionDeadlineDate": "2020-09-18T00:00:00-07:00",
      "ResolutionStatus": "VALID",
      "RejectReason": "",
      "FinalPayout": "0.28",
      "ResolutionDate": "2020-09-11T13:41:57-07:00",
      "CreationDate": "2020-09-11T13:41:52-07:00",
      "ActionId": "1017.4635.1023507",
      "ActionUri": "/Advertisers/<AccountSid>/Actions/1000.4635.1023507",
      "AutoApprovalDate": "2020-09-11T13:41:52-07:00",
      "Comments": [
        {
          "User": "Brad Clendenen",
          "Comment": "Please approve this ASAP!",
          "Date": "2020-09-11T13:41:52-07:00"
        }
      ],
      "Uri": "/Advertisers/<AccountSid>/ActionInquiries/778987"
    }
  ]
}

Retrieve an action inquiry

get

Retrieves the details of an existing action inquiry using its unique ID.

Path parameters

AccountSIDstringRequired

IdstringRequired

Responses

200

Returns an action inquiry object.

application/json

IdstringOptionalExample: 778987

CampaignIdstringOptionalExample: 1000

CampaignNamestringOptionalExample: Acme Campaign

MediaPartnerIdstringOptional

Only returns action inquiries for the partner specified by this ID.

Example: 10000

MediaPartnerNamestringOptionalExample: Acme Partner

OrderIdstringOptional

Only returns action inquiries associated with your unique order ID value for a conversion.

Example: 9234918172372

TransactionDatestring · date-timeOptionalExample: 2020-09-10T00:00:00-07:00

TransactionAmountstringOptionalExample: 14.00

InquiryTypestring · enumOptionalExample: UNTRACKEDPossible values:

ExpectedPayoutstringOptionalExample: 3.00

ResolutionDeadlineDatestring · date-timeOptionalExample: 2020-09-18T00:00:00-07:00

ResolutionStatusstring · enumOptional

Only returns action inquiries that match the specified resolution status.

Example: VALIDPossible values:

RejectReasonstringOptional

FinalPayoutstringOptionalExample: 0.28

ResolutionDatestring · date-timeOptionalExample: 2020-09-11T13:41:57-07:00

CreationDatestring · date-timeOptionalExample: 2020-09-11T13:41:52-07:00

ActionIdstringOptionalExample: 1017.4635.1023507

ActionUristringOptionalExample: /Advertisers/<AccountSid>/Actions/1000.4635.1023507

AutoApprovalDatestring · date-timeOptionalExample: 2020-09-11T13:41:52-07:00

UristringOptionalExample: /Advertisers/<AccountSid>/ActionInquiries/778987

get/Advertisers/{AccountSID}/ActionInquiries/{Id}

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/ActionInquiries/{Id} HTTP/1.1
Host: api.impact.com
Accept: */*

200

Returns an action inquiry object.

{
  "Id": "778987",
  "CampaignId": "1000",
  "CampaignName": "Acme Campaign",
  "MediaPartnerId": "10000",
  "MediaPartnerName": "Acme Partner",
  "OrderId": "9234918172372",
  "TransactionDate": "2020-09-10T00:00:00-07:00",
  "TransactionAmount": "14.00",
  "InquiryType": "UNTRACKED",
  "ExpectedPayout": "3.00",
  "ResolutionDeadlineDate": "2020-09-18T00:00:00-07:00",
  "ResolutionStatus": "VALID",
  "RejectReason": "",
  "FinalPayout": "0.28",
  "ResolutionDate": "2020-09-11T13:41:57-07:00",
  "CreationDate": "2020-09-11T13:41:52-07:00",
  "ActionId": "1017.4635.1023507",
  "ActionUri": "/Advertisers/<AccountSid>/Actions/1000.4635.1023507",
  "AutoApprovalDate": "2020-09-11T13:41:52-07:00",
  "Comments": [
    {
      "User": "Brad Clendenen",
      "Comment": "Please approve this ASAP!",
      "Date": "2020-09-11T13:41:52-07:00"
    }
  ],
  "Uri": "/Advertisers/<AccountSid>/ActionInquiries/778987"
}

Update an action inquiry

put

Updates the action inquiry with a resolution status (VALID, DECLINED, or INCOMPLETE) and optional transaction details.

Path parameters

AccountSIDstringRequired

IdstringRequired

Body

application/x-www-form-urlencoded

ResolutionStatusstring · enumRequiredExample: VALIDPossible values:

RejectReasonstring · enumOptional

Required if resolution status is DECLINED.

Example: Enquiry does not provide complete information required for evaluationPossible values:

ActionTrackerIdstringOptional

Required if resolution status is VALID.

Example: 4000

TransactionAmountnumberOptionalExample: 14

TransactionDatestring · date-timeOptionalExample: 2026-09-10T00:00:00-07:00

PromoCodestringOptionalExample: 10OFF-FORGE

CustomerIdstringOptionalExample: BCZ2WVSH674563PDPYOTM3AXDQ

ResolutionNotesstringOptionalExample: Customer confirmed delivery; approved.

FinalPayoutnumberOptionalExample: 0.28

ItemSku[i]stringOptional

ItemCategory[i]stringOptional

ItemName[i]stringOptional

For a VALID action inquiry, specifies the name of the item. This information can also be automatically appended through uploading a product catalog. impact.com highly recommends submitting this parameter when approving action inquiries to maintain accurate records & reporting.

Example: Acme Tennis Balls (One Dozen)

ItemSubCategory[i]stringOptional

The sub-category for the item.

Example: Tennis

ItemMPN[i]stringOptional

Manufacturer Part Number for the item; primarily used for retail sales.

Example: ACME-MPN-101

ItemTotalRebate[i]number · decimalOptional

Discount applied to this line item (not just for each product of this type).

Example: 5

ItemQty[i]stringOptional

ItemSubtotal[i]stringOptional

Responses

200

Success response.

application/json

StatusstringOptional

UristringOptional

put/Advertisers/{AccountSID}/ActionInquiries/{Id}

HTTPcURLJavaScriptPython

PUT /Advertisers/{AccountSID}/ActionInquiries/{Id} HTTP/1.1
Host: api.impact.com
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 572

"ResolutionStatus='VALID'&RejectReason='Enquiry does not provide complete information required for evaluation'&ActionTrackerId='4000'&TransactionAmount=14&TransactionDate='2026-09-10T00:00:00-07:00'&PromoCode='10OFF-FORGE'&CustomerId='BCZ2WVSH674563PDPYOTM3AXDQ'&ResolutionNotes='Customer confirmed delivery; approved.'&FinalPayout=0.28&ItemSku[i]='text'&ItemCategory[i]='text'&ItemName[i]='Acme Tennis Balls (One Dozen)'&ItemSubCategory[i]='Tennis'&ItemMPN[i]='ACME-MPN-101'&ItemTotalRebate[i]=5&ItemQty[i]='text'&ItemSubtotal[i]='text'"

200

Success response.

{
  "Status": "text",
  "Uri": "text"
}