Skip to main content
POST
/
v1
/
segments
Node.js SDK
import Migma from 'migma';

const migma = new Migma('YOUR_API_KEY');

const { data, error } = await migma.segments.create({
  name: 'Active Users',
  description: 'Users active in the last 30 days',
  projectId: 'PROJECT_ID'
});
{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "filters": {
      "tags": [
        "<string>"
      ],
      "status": "subscribed",
      "customFields": {}
    },
    "count": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "error": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication. Use 'Authorization: Bearer YOUR_API_KEY' where YOUR_API_KEY is obtained from the Migma dashboard under Settings → API Integration.

Body

application/json
name
string
required
Maximum string length: 200
projectId
string
required
description
string
Maximum string length: 500
filters
object

Response

Segment created

success
boolean
required
data
object
error
string | null