Bulk-add members by filter result

POST /v1/segments/:id/members/from-filter

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Request Body

application/jsonRequired

fromFilterRequiredarray<object>

Path Parameters

idRequiredstring

Segment id.

Pattern: "^[a-f0-9]{24}$"

POST/v1/segments/{id}/members/from-filter

curl -X POST "https://api.3common.com/v1/segments/string/members/from-filter" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "fromFilter": [
      {
        "logic": "and",
        "conditions": [
          null
        ],
        "property1": null,
        "property2": null
      }
    ]
  }'

Default Response

Response

{
  "matchedCount": 0,
  "insertedCount": 0,
  "memberCount": 0
}

TypeScript

export interface Response {
  matchedCount: number;
  insertedCount: number;
  memberCount: number;
}