Bulk-add members (static segments)

POST /v1/segments/:id/members

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Request Body

application/jsonRequired

memberIdsRequiredarray<string>

Path Parameters

idRequiredstring

Segment id.

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

POST/v1/segments/{id}/members

curl -X POST "https://api.3common.com/v1/segments/string/members" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "memberIds": [
      "string"
    ]
  }'

Default Response

Response

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

TypeScript

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