Creates an action inquiry by setting the values of the required parameters. The required parameters will need to be passed or else the action inquiry will fail to create.
Parameters
CampaignId
required
CampaignId
requiredUnique identifier for the campaign (or Program) that this action inquiry is in.
OrderId
required
OrderId
requiredYour unique identifier for the consumer order associated with this conversion. For example, with a standard retail event type, this value would be the order number the consumer receives when they converted. An OrderId
(or Oid
) is only required to be unique to the event type (or action tracker) that tracked this conversion.
TransactionDate
required
TransactionDate
requiredDate and time when the transaction occurred, expressed in ISO 8601 format.
TransactionAmount
required
TransactionAmount
requiredRevenue amount associated with this action.
InquiryType
required enum
InquiryType
required enumThe reason this action inquiry was submitted.
Possible enum values | |
---|---|
UNTRACKED | Action wasn't tracked for the partner. |
INCORRECT | Action was incorrectly tracked. Refer to the notes left by the partner in the Comments attribute. |
DECLINED | Action was wrongly declined. |
MediaPartnerInquiryId
optional
MediaPartnerInquiryId
optionalUnique identifier for the partner that created the action inquiry.
ResolutionDeadlineDate
optional
ResolutionDeadlineDate
optionalDate and time of the deadline that a partner expects to receive a resolution for this action inquiry, expressed in ISO 8601 format. For loyalty partners, this typically represents an SLA to their customers.
ExpectedPayout
optional
ExpectedPayout
optionalPayout amount that the partner expected to receive for the action.
TrackingLink
optional
TrackingLink
optionalThe tracking link used by the partner that lead to this action.
CustomerId
optional
CustomerId
optionalA unique identifier for the customer.
InquiryDate
optional
InquiryDate
optionalDate and time when the inquiry occurred, expressed in ISO 8601 format.
InquiryNotes
optional
InquiryNotes
optionalThese are the notes left by the partner when submitting an inquiry.
Example request
curl 'https://api.impact.com/Mediapartners/<AccountSid>/ActionInquiries' \
-X POST \
-u '<AccountSID>:<AuthToken>' \
-H 'Accept: application/json' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'CampaignId=782287' \
-d 'OrderId=O12345' \
-d 'TransactionDate=2021-04-01T00:10:00Z' \
-d 'TransactionAmount=100' \
-d 'InquiryType=INCORRECT'
Example response
{
"Status": "OK",
"Uri": "/Mediapartners/<AccountSID>/ActionInquiries/1407290"
}