Routing Rules
Returns a list of all routing rules for a specific program, with extensive filtering options.
Your unique Account SID.
The ID of the program the rules belong to.
Filter rules by the type of condition that triggers them.
Return routing rules that start before a specific date and time (ISO 8601).
Return routing rules that start after a specific date and time (ISO 8601).
Return routing rules that end before a specific date and time (ISO 8601).
Return routing rules that end after a specific date and time (ISO 8601).
Return routing rules that were last updated before a specific date and time (ISO 8601).
Return routing rules that were last updated after a specific date and time (ISO 8601).
Return routing rules that were created before a specific date and time (ISO 8601).
Return routing rules that were created after a specific date and time (ISO 8601).
Return routing rules that were created by a specific account user.
Return routing rules that were last updated by a specific account user.
From where the routing rule was created. Possible values:
GENERIC— Created via the Create-a-routing-rule endpoint or the Blocking and Redirect Technical Settings screen.AD— Created when an associated ad was created.COMPLIANCE— Created as the result of a Compliance violation.TASK— Created from the web app's Task Management system.
A paginated list of routing rule objects.
GET /Advertisers/{AccountSID}/Programs/{ProgramId}/BlockRedirectRules HTTP/1.1
Host: api.impact.com
Accept: */*
A paginated list of routing rule objects.
{
"BlockRedirectRules": [
{
"Id": "50000",
"Name": "Redirect 4",
"Condition": [
{
"SubConditions": [
{
"Variable": "COUNTRY",
"Operator": "IN",
"Values": [
"US"
]
}
]
}
],
"Action": "REDIRECT",
"RedirectUrl": "http://impact.com",
"Interstitial": {
"HeaderText": "Welcome to Acme",
"BodyText": "Please confirm your details to continue.",
"RequireUserAcknowledgement": true,
"ButtonText": "Continue",
"ButtonColor": "#FF0000",
"RequireUserInput": true,
"UserInputs": [
{
"Variable": "SHARED_ID",
"DisplayValue": "Email Address",
"RegularExpression": "^[^@]+@[^@]+\\.[^@]+$",
"ErrorMessage": "Please enter a valid email address."
}
],
"IncludeSkipOption": false,
"ShowPageAtLeastOnce": true,
"CoBranded": false,
"CustomizeCss": false,
"CustomCss": ""
},
"Rank": "HIGH",
"State": "RUNNING",
"StartDate": "2026-01-01T00:00:00-08:00",
"EndDate": "2026-12-31T23:59:59-08:00",
"Source": "GENERIC",
"DateCreated": "2019-10-28T17:53:01-04:00",
"DateLastUpdated": "2019-10-28T17:53:01-04:00",
"CreatedBy": "ACME Corp",
"LastUpdatedBy": "ACME Corp",
"Uri": "/Advertisers/<AccountSID>/Programs/1000/BlockRedirectRules/50000"
}
]
}Retrieves the details of a single, existing routing rule by its unique ID.
Your unique Account SID.
The ID of the program the rule belongs to.
The unique identifier for the routing rule.
A single routing rule object.
The unique identifier for the routing rule.
50000Name of the routing rule.
Redirect 4What traffic will experience if the routing rule is triggered.
REDIRECTPossible values: The destination URL for REDIRECT-type rules.
http://impact.comThis determines the specific routing rule's rank in relation to others that have the same conditions.
HIGHPossible values: What state of use the routing rule is in.
RUNNINGPossible values: The date and time the rule becomes active.
2026-01-01T00:00:00-08:00The date and time the rule expires.
2026-12-31T23:59:59-08:00From where the routing rule was created.
GENERICPossible values: The date and time the rule was created.
2019-10-28T17:53:01-04:00The date and time the rule was last updated.
2019-10-28T17:53:01-04:00The account user that created the rule.
ACME CorpThe account user that last updated the rule.
ACME CorpThe unique reference to this routing rule in the impact.com API.
/Advertisers/<AccountSID>/Programs/1000/BlockRedirectRules/50000GET /Advertisers/{AccountSID}/Programs/{ProgramId}/BlockRedirectRules/{RuleId} HTTP/1.1
Host: api.impact.com
Accept: */*
A single routing rule object.
{
"Id": "50000",
"Name": "Redirect 4",
"Condition": [
{
"SubConditions": [
{
"Variable": "COUNTRY",
"Operator": "IN",
"Values": [
"US"
]
}
]
}
],
"Action": "REDIRECT",
"RedirectUrl": "http://impact.com",
"Interstitial": {
"HeaderText": "Welcome to Acme",
"BodyText": "Please confirm your details to continue.",
"RequireUserAcknowledgement": true,
"ButtonText": "Continue",
"ButtonColor": "#FF0000",
"RequireUserInput": true,
"UserInputs": [
{
"Variable": "SHARED_ID",
"DisplayValue": "Email Address",
"RegularExpression": "^[^@]+@[^@]+\\.[^@]+$",
"ErrorMessage": "Please enter a valid email address."
}
],
"IncludeSkipOption": false,
"ShowPageAtLeastOnce": true,
"CoBranded": false,
"CustomizeCss": false,
"CustomCss": ""
},
"Rank": "HIGH",
"State": "RUNNING",
"StartDate": "2026-01-01T00:00:00-08:00",
"EndDate": "2026-12-31T23:59:59-08:00",
"Source": "GENERIC",
"DateCreated": "2019-10-28T17:53:01-04:00",
"DateLastUpdated": "2019-10-28T17:53:01-04:00",
"CreatedBy": "ACME Corp",
"LastUpdatedBy": "ACME Corp",
"Uri": "/Advertisers/<AccountSID>/Programs/1000/BlockRedirectRules/50000"
}Last updated

