POST /segments
Create a new segment
Servers
- https://services.adroll.com/audience/v1
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
sfdc_company_list_id |
String | No |
Represents the salesforce company list id that this segment references |
data[] |
Array | Yes |
User records to add |
data[].id |
String | No |
Unique user identifier synced to AdRoll via Cookie Match. Used with |
data[].email |
String | No |
Email RFC 5322 standard. Used with |
is_conversion |
Boolean | No |
true if a segment is a conversion segment |
name |
String | Yes |
Name given to the segment upon creation |
advertiser_id |
String | Yes |
ID of the advertiser to create a new segment for |
general_exclusion_type |
String | No |
Represents the general exclusion type Possible values:
|
type |
String | Yes |
Represents the segment type Possible values:
|
duration |
Integer | Yes |
Number of days (1 to 540) members are valid in a segment |
conversion_value |
Number | No |
new conversion value to be associated with the conversion segment |
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.