Favicon

You are here: Home > API Reference > Platform > Segment > Create segment

Create segment

Required Permission: base.organization.segment.create

Create segment

POST
https://api.applivery.io/v1/organizations/{organizationId}/segments 
curl -X POST "https://api.applivery.io/v1/organizations/{organizationId}/segments" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "icon": "string",
  "color": "string",
  "parentId": 0
}'
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/segments", {
  method: "POST",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "icon": "string",
    "color": "string",
    "parentId": 0
  }),
});

const data = await response.json();
import requests

response = requests.post(
    "https://api.applivery.io/v1/organizations/{organizationId}/segments",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "name": "string",
      "icon": "string",
      "color": "string",
      "parentId": 0
    },
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Body Params application/json
name string required
≤ 256 characters
icon string optional
≤ 256 characters
color any optional
parentId number optional 
{
    "name": "string",
    "icon": "string",
    "color": "string",
    "parentId": 0
}

Responses

200 Response application/json
status boolean required
data object required
id number required
name string required
≤ 256 characters
icon string optional
≤ 256 characters
color any optional
children array [object] required 
{
    "status": true,
    "data": {
        "id": 0,
        "name": "string",
        "icon": "string",
        "color": "string",
        "children": [
            {}
        ]
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5017
message string optional
Limit Exceeded
{
    "status": false,
    "error": {
        "code": 5017,
        "message": "Limit Exceeded"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}