POST /segments/{segment_eid}
Users can be appended to a segment by including a list of the appropriate user record objects in the payload
Servers
- https://services.adroll.com/audience/v1
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
segment_eid |
String | Yes |
EID of the segment |
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 |
name |
String | Yes |
Name shown on client's dashboard |
general_exclusion_type |
String | No |
Represents the general exclusion type Possible values:
|
duration |
Integer | No |
Number of days (1 to 540) members are valid in a segment |
conversion_value |
Number | No |
new conversion value to be associated with the existing 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.