# Create new segment

Create a new segment.

Endpoint: POST /audiences/{audienceId}/segments
Version: 1.0.0
Security: TdApikeyAuth

## Security:

  - `TdApikeyAuth` (unknown)
    apiKey in header Authorization

## Path parameters:

  - `audienceId` (integer, required)
    Master Segment id of the segment

## Request body:

  - `application/json` (unknown)
    Segment parameters to create

## Request fields (application/json):

  - `audienceId` (integer)

  - `name` (string)

  - `realtime` (boolean)
    use `kind` instead

  - `kind` (integer)
    0: batch, 1: realtime, 2: funnel_stage

  - `funnel_stage` (object)
    required if creating segment as a rule of funnel_stage

  - `funnel_stage.funnel_id` (integer)

  - `funnel_stage.stage_id` (integer)

  - `description` (string)

  - `segmentFolderId` (integer)

  - `rule` (any)

  - `rule.conditions` (array, required)

  - `rule.conditions.conditions` (array, required)

  - `rule.conditions.conditions.exclude` (boolean, required)

  - `rule.conditions.conditions.id` (string, required)

  - `rule.conditions.conditions.type` (string, required)
    Enum: "FunnelStageReference", "Reference", "AbTestVariantReference"

  - `rule.conditions.conditions.includeConvertedCustomers` (boolean, required)

  - `rule.conditions.conditions.maxGrade` (number, required)

  - `rule.conditions.conditions.minGrade` (number, required)

  - `rule.conditions.conditions.type` (string, required)
    Enum: "PredictiveScoreReference"

  - `rule.conditions.conditions.leftValue` (object, required)

  - `rule.conditions.conditions.leftValue.attribute` (string, required)
    Enum: "r_quartile", "f_quartile", "m_quartile", "rfm_segment", "rfm_score", "rfm_cluster_rank", "rfm_quartile"

  - `rule.conditions.conditions.operator` (any, required)

  - `rule.conditions.conditions.solutionType` (string, required)
    Enum: "rfm"

  - `rule.conditions.conditions.type` (string, required)
    Enum: "MlAttributeReference"

  - `rule.conditions.conditions.solutionType` (string, required)
    Enum: "cltv"

  - `rule.conditions.conditions.arrayMatching` (any, required)

  - `rule.conditions.conditions.arrayMatching.atLeast` (number, required)

  - `rule.conditions.conditions.arrayMatching.atMost` (number, required)

  - `rule.conditions.conditions.arrayMatching.exactly` (number, required)

  - `rule.conditions.conditions.limit` (object)

  - `rule.conditions.conditions.limit.number` (number, required)

  - `rule.conditions.conditions.limit.orderColumns` (array)

  - `rule.conditions.conditions.limit.type` (string, required)
    Enum: "Count", "Percent"

  - `rule.conditions.conditions.type` (string, required)
    Enum: "Value"

  - `rule.conditions.description` (string)

  - `rule.conditions.expr` (string)

  - `rule.conditions.type` (string, required)
    Enum: "Or", "And", "Composite"

  - `rule.expr` (string)

  - `rule.type` (string, required)
    Enum: "Or", "And", "Composite"

  - `countPopulation` (boolean)

## Response 400:

  - `400` (unknown)
    Given parameters are not valid

## Response 400 fields (application/json):

  - `code` (string, required)

  - `message` (string, required)

## Response 401:

  - `401` (unknown)
    Unauthorized; You don't provide valid credentials. Maybe you didn't specify valid TD's Master API Key as 'TD1 {Your TD Master API Key}'.

## Response 401 fields (application/json):

  - `code` (string, required)

  - `message` (string, required)

## Response 403:

  - `403` (unknown)
    Requested resource or action is not allowed because you don't have sufficient permissions

## Response 403 fields (application/json):

  - `code` (string, required)

  - `message` (string, required)

## Response 404:

  - `404` (unknown)
    The specified resource was not found

## Response 404 fields (application/json):

  - `code` (string, required)

  - `message` (string, required)

## Response 4XX:

  - `4XX` (unknown)
    There is a high possibility of error of the authentication system. Please check the contents and authority of the key. Please contact the TD support team if you do not resolve it.

## Response 4XX fields (application/json):

  - `code` (string, required)

  - `message` (string, required)

## Response 5XX:

  - `5XX` (unknown)
    System error. Because there is a possibility of a temporary error due to network trouble and so on, we recommend several times retry on request side. Please contact the TD support team if you do not resolve it.

## Response 5XX fields (application/json):

  - `status` (integer, required)
    Error status

  - `error` (string, required)
    Error message

  - `details` (string)
    Detailed error message

