POST /rule/create
Create a new rule on a given pixel.
Servers
- https://services.adroll.com/api/v1
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
pixel |
String | Yes |
The EID of the pixel in which we want to create a new rule |
source |
String | Yes |
one of [c, d, m] (c=cookie, d=crm_data, m=mobile) |
order |
Integer | Yes |
The priority order in which this rule needs to be applied among the others. Must be unique in the Pixel. The lower the number, the higher the priority. |
name |
String | No |
The arbitrary name of the rule (Optional; default: None). |
type |
String | Yes |
The type of the rule being created. One of [c, s, p, b] (c=Conversion, s=Segment, p=Prospect, b=Cart). You can't change this later. |
display_name |
String | No |
The display name of the rule (Optional; default: None). |
pattern |
String | Yes |
The regexp-like expression that matches a URL, if creating a URL rule. |
duration |
Integer | Yes |
The duration of inactivity that can elapse before a user is dropped from this rule. |
csv_file |
String | Yes |
A CSV file with the emails to generate the rule from, if creating a CRM rule. Use a multi-part form request. Must contain at least 100 emails. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.