> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mapp.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create a segment plan
> Creates a new segment plan. The request body is a wrapper whose json field carries the raw plan JSON document as a string (escaped). The plan must contain at least name and nodes; validate it against schema first. Returns the new plan's id.
Example body
{
"json": "{\"name\":\"My plan\",\"timeZoneId\":\"Europe/Belgrade\",\"nodes\":[ ... ]}"
}
## OpenAPI
````json POST /segmentation/create
{
"openapi": "3.0.4",
"info": {
"title": "Engage public API",
"version": "1"
},
"servers": [
{
"url": "https://your-engage-domain.com/api/rest"
}
],
"tags": [
{
"name": "Address Attributes"
},
{
"name": "Async"
},
{
"name": "Audit Log"
},
{
"name": "Automation"
},
{
"name": "Blacklist"
},
{
"name": "CMS"
},
{
"name": "Contact"
},
{
"name": "Content"
},
{
"name": "Coupon"
},
{
"name": "Draft Message"
},
{
"name": "Ecommerce"
},
{
"name": "Group"
},
{
"name": "Group Attributes"
},
{
"name": "Landing Page"
},
{
"name": "Member Attributes"
},
{
"name": "Membership"
},
{
"name": "Message"
},
{
"name": "Meta"
},
{
"name": "Mobile Push"
},
{
"name": "Prepared Message"
},
{
"name": "Process"
},
{
"name": "Profile Attributes"
},
{
"name": "Related Data"
},
{
"name": "Segmentation"
},
{
"name": "System"
},
{
"name": "System User"
},
{
"name": "Usage Statistics"
},
{
"name": "User"
},
{
"name": "Whiteboard"
}
],
"paths": {
"/segmentation/create": {
"post": {
"tags": [
"Segmentation"
],
"summary": "Create a segment plan",
"description": "Creates a new segment plan. The request body is a wrapper whose json field carries the raw plan JSON document as a string (escaped). The plan must contain at least name and nodes; validate it against schema first. Returns the new plan's id.{\n \"json\": \"{\\\"name\\\":\\\"My plan\\\",\\\"timeZoneId\\\":\\\"Europe/Belgrade\\\",\\\"nodes\\\":[ ... ]}\"\n}",
"operationId": "create",
"requestBody": {
"description": "Wrapper carrying the raw plan JSON document as a string in its 'json' field.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentationPayload"
}
}
},
"x-bodyName": "body"
},
"responses": {
"200": {
"description": "The new plan's id, e.g. {\"id\":\"...\"}.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentationReference"
}
}
}
},
"400": {
"description": "bad request",
"content": {
"application/json": {}
}
}
}
}
}
},
"components": {
"schemas": {
"SegmentationPayload": {
"type": "object",
"properties": {
"json": {
"type": "string"
}
}
},
"SegmentationReference": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
}
}
````