APappdirect
SegmentFolders

Create dynamic segments

Changed on

Creates a dynamic segment. Dynamic segments contain user selected automatically based on filter values, as opposed to manual segments, in which Marketplace Managers select companies manually.

post/channel/v1/segments/dynamicSegments

Request

Query parameters

companyGroupIdstring required

Segment folder ID

Request body

namestring required

Segment name

codestring

Segment code

Example request

{
  "name": "Canada",
  "code": "XXYU",
  "filters": [
    [
      {
        "conditions": [
          {
            "parameter": "company.state",
            "operator": "matches",
            "values": [
              "Quebec"
            ]
          },
          {
            "parameter": "company.city",
            "operator": "matches",
            "values": [
              "Montreal"
            ]
          }
        ]
      },
      {
        "conditions": [
          {
            "parameter": "company.state",
            "operator": "matches",
            "values": [
              "Quebec"
            ]
          },
          {
            "parameter": "company.city",
            "operator": "matches",
            "values": [
              "Montreal"
            ]
          }
        ]
      }
    ]
  ]
}

Response

OK

idstring

Segment ID

namestring

Segment name

codestring

Segment codes are unique codes that you can use for B2B integration by using the API to automatically associate companies with segments. Leave this field blank if a segment code is not required. Note that if you modify the code after you create it, your B2B integration might be affected.

partnerstring

Partner name

typestring

Segment type

Example response

{
  "id": "04f8d043-10f1-4b89-8c0e-0780e5a62299",
  "name": "iOS users",
  "partner": "APPDIRECT",
  "type": "DYNAMIC",
  "filters": [
    [
      {
        "conditions": [
          {
            "parameter": "company.state",
            "operator": "matches",
            "values": [
              "Quebec"
            ]
          },
          {
            "parameter": "company.city",
            "operator": "matches",
            "values": [
              "Montreal"
            ]
          }
        ]
      },
      {
        "conditions": [
          {
            "parameter": "company.state",
            "operator": "matches",
            "values": [
              "Quebec"
            ]
          },
          {
            "parameter": "company.city",
            "operator": "matches",
            "values": [
              "Montreal"
            ]
          }
        ]
      }
    ]
  ]
}

Changes