Required parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
name | Body | string | Yes | Segment name. |
refreshType | Body | integer | Yes | Segment type. Use 1 for Static and 2 for Dynamic. |
Body fields
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Segment name. |
refreshType | integer | Yes | Use 1 for Static or 2 for Dynamic. |
groups | array of objects | Conditionally | A set of filtering condition groups used to filter contacts. Required when refreshType = 2. Optional when refreshType = 1, but for static segments you must provide either groups or contactIds. |
contactIds | array | Conditionally | List of contact IDs used to directly define members in a static segment. For static segments, provide contactIds or groups. |
useUploadedContact | boolean | No | Indicates whether to use the uploaded contacts logic for the downstream CDP segment API. Defaults to false when not provided. |
Group structure
Each item in groups contains a conditions array.
Each condition includes:
attribute— field name, such as a contact field or custom attribute likenameorphoneoperator— comparison operator, such as==value— comparison value