Update segment

1 min

PUT

https://api.us1.odp.optimizely.com/v3/segments/{segment_id}

Modify the parameters of an existing segment.

Path Parameters

segment_idstringrequired

Body Parameters

bodyobjectrequired
- descriptionstring
  Example
  Customer has email
- metadatamap<string, string>
  Example
```
{
  "display_name": "Customer Has Email"
}
```
- definitionSegmentDefinition
  Example
```
{
  "root_condition": {
    "customer_condition": {
      "customer_filter": {
        "is_not_missing": {
          "source": {
            "path_reference": {
              "value": "customer.email"
            }
          }
        }
      }
    }
  }
}
```
  - root_conditionobject
    Description
    Condition that defines audience membership. Mutually exclusive with external.
    - Condition
      - combinationCondition.Combination
        conjunctionConjunction
        Default
        CONJUNCTION_NOT_SET
        conditionsCondition[]
        Circular-Reference
      - customer_conditionCustomerCondition
        customer_filterobject
        Description
        Must evaluate to boolean.
        Expression
        combinationExpression.Combination
        Description
        Evaluates to boolean.
        conjunctionConjunction
        Default
        CONJUNCTION_NOT_SET
        expressionsExpression[]
        Description
        Cannot be empty; all must evaluate to boolean.
        Circular-Reference
        comparisonComparison
        Description
        Evaluates to boolean.
        lhsExpression
        Circular-Reference
        comparatorComparator
        Default
        COMPARATOR_NOT_SET
        rhsExpression
        Circular-Reference
        path_referencePathReference
        Description
        Evaluates to type of referenced field.
        valuestring
        string_literalStringLiteral
        Description
        Evaluates to string.
        valuestring
        number_literalNumberLiteral
        Description
        Evaluates to number.
        valuestring
        boolean_literalBooleanLiteral
        Description
        Evaluates to boolean.
        valueboolean
        is_missingIsMissing
        Description
        Evaluates to boolean.
        sourceExpression
        Circular-Reference
        is_not_missingIsNotMissing
        Description
        Evaluates to boolean.
        sourceExpression
        Circular-Reference
        false_or_missingFalseOrMissing
        Description
        Evaluates to boolean.
        sourceobject
        Description
        Must evaluate to boolean.
        Expression
        Circular-Reference
        true_or_missingTrueOrMissing
        Description
        Evaluates to boolean.
        sourceobject
        Description
        Must evaluate to boolean.
        Expression
        Circular-Reference
        coalesceCoalesce
        Description
        Evaluates to type of source.
        sourcesExpression[]
        Description
        Must all evaluate to same type.
        Circular-Reference
        truncate_timeTruncateTime
        Description
        Evaluates to number (epoch seconds).
        sourceobject
        Description
        Must evaluate to a number (epoch seconds).
        Expression
        Circular-Reference
        unitTimeUnit
        Default
        TIME_UNIT_NOT_SET
        timezoneobject
        Description
        Only required when unit = DAY, must evaluate to a string (IANA timezone name).
        Expression
        Circular-Reference
        shift_timeShiftTime
        Description
        Evaluates to number (epoch seconds).
        sourceobject
        Description
        Must evaluate to a number (epoch seconds).
        Expression
        Circular-Reference
        amountobject
        Description
        Must evaluate to a number (seconds).
        Expression
        Circular-Reference
        unitTimeUnit
        Default
        TIME_UNIT_NOT_SET
        timezoneobject
        Description
        Only required when unit = DAY, must evaluate to a string (IANA timezone name).
        Expression
        Circular-Reference
        any_of_stringAnyOfString
        Description
        Evaluates to boolean.
        needleExpression
        Circular-Reference
        haystackstring[]
        any_of_numberAnyOfNumber
        Description
        Evaluates to boolean.
        needleExpression
        Circular-Reference
        haystackstring[]
        none_of_stringNoneOfString
        Description
        Evaluates to boolean.
        needleExpression
        Circular-Reference
        haystackstring[]
        none_of_numberNoneOfNumber
        Description
        Evaluates to boolean.
        needleExpression
        Circular-Reference
        haystackstring[]
        like_any_of_stringLikeAnyOfString
        Description
        Evaluates to boolean.
        needleExpression
        Circular-Reference
        haystackstring[]
        like_none_of_stringLikeNoneOfString
        Description
        Evaluates to boolean.
        needleExpression
        Circular-Reference
        haystackstring[]
        is_list_memberIsListMember
        Description
        Evaluates to boolean.
        liststring
        is_not_list_memberIsNotListMember
        Description
        Evaluates to boolean.
        liststring
        goalobject
        Description
        Optional. The customer matches only after customer_filter is true and this continuation completes. If disqualifier is also set, the customer matches only if it hasn't fired.
        CustomerContinuation
        combinationobject
        Description
        Combines continuations with AND or OR.
        CustomerContinuation.Combination
        conjunctionConjunction
        Default
        CONJUNCTION_NOT_SET
        continuationsCustomerContinuation[]
        Description
        Cannot be empty.
        Circular-Reference
        timeout_sourceobject
        Description
        Evaluated when the customer starts matching customer_filter; must evaluate to a number (epoch seconds). Completes once that time has passed. Fields it references must be checked with is_not_missing in customer_filter.
        Expression
        combinationExpression.Combination
        Description
        Evaluates to boolean.
        conjunctionConjunction
        Default
        CONJUNCTION_NOT_SET
        Max depth limit reached
        expressionsExpression[]
        Description
        Cannot be empty; all must evaluate to boolean.
        Max depth limit reached
        comparisonComparison
        Description
        Evaluates to boolean.
        lhsExpression
        Max depth limit reached
        comparatorComparator
        Default
        COMPARATOR_NOT_SET
        Max depth limit reached
        rhsExpression
        Max depth limit reached
        path_referencePathReference
        Description
        Evaluates to type of referenced field.
        valuestring
        string_literalStringLiteral
        Description
        Evaluates to string.
        valuestring
        number_literalNumberLiteral
        Description
        Evaluates to number.
        valuestring
        boolean_literalBooleanLiteral
        Description
        Evaluates to boolean.
        valueboolean
        is_missingIsMissing
        Description
        Evaluates to boolean.
        sourceExpression
        Max depth limit reached
        is_not_missingIsNotMissing
        Description
        Evaluates to boolean.
        sourceExpression
        Max depth limit reached
        false_or_missingFalseOrMissing
        Description
        Evaluates to boolean.
        sourceobject
        Description
        Must evaluate to boolean.
        Expression
        Max depth limit reached
        true_or_missingTrueOrMissing
        Description
        Evaluates to boolean.
        sourceobject
        Description
        Must evaluate to boolean.
        Expression
        Max depth limit reached
        coalesceCoalesce
        Description
        Evaluates to type of source.
        sourcesExpression[]
        Description
        Must all evaluate to same type.
        Max depth limit reached
        truncate_timeTruncateTime
        Description
        Evaluates to number (epoch seconds).
        sourceobject
        Description
        Must evaluate to a number (epoch seconds).
        Expression
        Max depth limit reached
        unitTimeUnit
        Default
        TIME_UNIT_NOT_SET
        Max depth limit reached
        timezoneobject
        Description
        Only required when unit = DAY, must evaluate to a string (IANA timezone name).
        Expression
        Max depth limit reached
        shift_timeShiftTime
        Description
        Evaluates to number (epoch seconds).
        sourceobject
        Description
        Must evaluate to a number (epoch seconds).
        Expression
        Max depth limit reached
        amountobject
        Description
        Must evaluate to a number (seconds).
        Expression
        Max depth limit reached
        unitTimeUnit
        Default
        TIME_UNIT_NOT_SET
        Max depth limit reached
        timezoneobject
        Description
        Only required when unit = DAY, must evaluate to a string (IANA timezone name).
        Expression
        Max depth limit reached
        any_of_stringAnyOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        any_of_numberAnyOfNumber
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        none_of_stringNoneOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        none_of_numberNoneOfNumber
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        like_any_of_stringLikeAnyOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        like_none_of_stringLikeNoneOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        is_list_memberIsListMember
        Description
        Evaluates to boolean.
        liststring
        is_not_list_memberIsNotListMember
        Description
        Evaluates to boolean.
        liststring
        disqualifierobject
        Description
        Optional. A customer matching customer_filter stops matching once this continuation completes. With goal, it also removes a customer who already reached the goal.
        CustomerContinuation
        combinationobject
        Description
        Combines continuations with AND or OR.
        CustomerContinuation.Combination
        conjunctionConjunction
        Default
        CONJUNCTION_NOT_SET
        continuationsCustomerContinuation[]
        Description
        Cannot be empty.
        Circular-Reference
        timeout_sourceobject
        Description
        Evaluated when the customer starts matching customer_filter; must evaluate to a number (epoch seconds). Completes once that time has passed. Fields it references must be checked with is_not_missing in customer_filter.
        Expression
        combinationExpression.Combination
        Description
        Evaluates to boolean.
        conjunctionConjunction
        Default
        CONJUNCTION_NOT_SET
        Max depth limit reached
        expressionsExpression[]
        Description
        Cannot be empty; all must evaluate to boolean.
        Max depth limit reached
        comparisonComparison
        Description
        Evaluates to boolean.
        lhsExpression
        Max depth limit reached
        comparatorComparator
        Default
        COMPARATOR_NOT_SET
        Max depth limit reached
        rhsExpression
        Max depth limit reached
        path_referencePathReference
        Description
        Evaluates to type of referenced field.
        valuestring
        string_literalStringLiteral
        Description
        Evaluates to string.
        valuestring
        number_literalNumberLiteral
        Description
        Evaluates to number.
        valuestring
        boolean_literalBooleanLiteral
        Description
        Evaluates to boolean.
        valueboolean
        is_missingIsMissing
        Description
        Evaluates to boolean.
        sourceExpression
        Max depth limit reached
        is_not_missingIsNotMissing
        Description
        Evaluates to boolean.
        sourceExpression
        Max depth limit reached
        false_or_missingFalseOrMissing
        Description
        Evaluates to boolean.
        sourceobject
        Description
        Must evaluate to boolean.
        Expression
        Max depth limit reached
        true_or_missingTrueOrMissing
        Description
        Evaluates to boolean.
        sourceobject
        Description
        Must evaluate to boolean.
        Expression
        Max depth limit reached
        coalesceCoalesce
        Description
        Evaluates to type of source.
        sourcesExpression[]
        Description
        Must all evaluate to same type.
        Max depth limit reached
        truncate_timeTruncateTime
        Description
        Evaluates to number (epoch seconds).
        sourceobject
        Description
        Must evaluate to a number (epoch seconds).
        Expression
        Max depth limit reached
        unitTimeUnit
        Default
        TIME_UNIT_NOT_SET
        Max depth limit reached
        timezoneobject
        Description
        Only required when unit = DAY, must evaluate to a string (IANA timezone name).
        Expression
        Max depth limit reached
        shift_timeShiftTime
        Description
        Evaluates to number (epoch seconds).
        sourceobject
        Description
        Must evaluate to a number (epoch seconds).
        Expression
        Max depth limit reached
        amountobject
        Description
        Must evaluate to a number (seconds).
        Expression
        Max depth limit reached
        unitTimeUnit
        Default
        TIME_UNIT_NOT_SET
        Max depth limit reached
        timezoneobject
        Description
        Only required when unit = DAY, must evaluate to a string (IANA timezone name).
        Expression
        Max depth limit reached
        any_of_stringAnyOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        any_of_numberAnyOfNumber
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        none_of_stringNoneOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        none_of_numberNoneOfNumber
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        like_any_of_stringLikeAnyOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        like_none_of_stringLikeNoneOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        is_list_memberIsListMember
        Description
        Evaluates to boolean.
        liststring
        is_not_list_memberIsNotListMember
        Description
        Evaluates to boolean.
        liststring
        inverseboolean
        Description
        Optional, defaults to false. If true, negates the condition, so it matches customers who don't satisfy it (including goal and disqualifier).
      - sequence_conditionSequenceCondition
        sequenceSequence
        entry_event_filterobject
        Description
        Must evaluate to a boolean.
        Expression
        combinationExpression.Combination
        Description
        Evaluates to boolean.
        conjunctionConjunction
        Default
        CONJUNCTION_NOT_SET
        Max depth limit reached
        expressionsExpression[]
        Description
        Cannot be empty; all must evaluate to boolean.
        Max depth limit reached
        comparisonComparison
        Description
        Evaluates to boolean.
        lhsExpression
        Max depth limit reached
        comparatorComparator
        Default
        COMPARATOR_NOT_SET
        Max depth limit reached
        rhsExpression
        Max depth limit reached
        path_referencePathReference
        Description
        Evaluates to type of referenced field.
        valuestring
        string_literalStringLiteral
        Description
        Evaluates to string.
        valuestring
        number_literalNumberLiteral
        Description
        Evaluates to number.
        valuestring
        boolean_literalBooleanLiteral
        Description
        Evaluates to boolean.
        valueboolean
        is_missingIsMissing
        Description
        Evaluates to boolean.
        sourceExpression
        Max depth limit reached
        is_not_missingIsNotMissing
        Description
        Evaluates to boolean.
        sourceExpression
        Max depth limit reached
        false_or_missingFalseOrMissing
        Description
        Evaluates to boolean.
        sourceobject
        Description
        Must evaluate to boolean.
        Expression
        Max depth limit reached
        true_or_missingTrueOrMissing
        Description
        Evaluates to boolean.
        sourceobject
        Description
        Must evaluate to boolean.
        Expression
        Max depth limit reached
        coalesceCoalesce
        Description
        Evaluates to type of source.
        sourcesExpression[]
        Description
        Must all evaluate to same type.
        Max depth limit reached
        truncate_timeTruncateTime
        Description
        Evaluates to number (epoch seconds).
        sourceobject
        Description
        Must evaluate to a number (epoch seconds).
        Expression
        Max depth limit reached
        unitTimeUnit
        Default
        TIME_UNIT_NOT_SET
        Max depth limit reached
        timezoneobject
        Description
        Only required when unit = DAY, must evaluate to a string (IANA timezone name).
        Expression
        Max depth limit reached
        shift_timeShiftTime
        Description
        Evaluates to number (epoch seconds).
        sourceobject
        Description
        Must evaluate to a number (epoch seconds).
        Expression
        Max depth limit reached
        amountobject
        Description
        Must evaluate to a number (seconds).
        Expression
        Max depth limit reached
        unitTimeUnit
        Default
        TIME_UNIT_NOT_SET
        Max depth limit reached
        timezoneobject
        Description
        Only required when unit = DAY, must evaluate to a string (IANA timezone name).
        Expression
        Max depth limit reached
        any_of_stringAnyOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        any_of_numberAnyOfNumber
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        none_of_stringNoneOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        none_of_numberNoneOfNumber
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        like_any_of_stringLikeAnyOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        like_none_of_stringLikeNoneOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        is_list_memberIsListMember
        Description
        Evaluates to boolean.
        liststring
        is_not_list_memberIsNotListMember
        Description
        Evaluates to boolean.
        liststring
        unique_key_sourcesExpression[]
        Description
        Optional, each must evaluate to a primitive.
        combinationExpression.Combination
        Description
        Evaluates to boolean.
        conjunctionConjunction
        Default
        CONJUNCTION_NOT_SET
        Max depth limit reached
        expressionsExpression[]
        Description
        Cannot be empty; all must evaluate to boolean.
        Max depth limit reached
        comparisonComparison
        Description
        Evaluates to boolean.
        lhsExpression
        Max depth limit reached
        comparatorComparator
        Default
        COMPARATOR_NOT_SET
        Max depth limit reached
        rhsExpression
        Max depth limit reached
        path_referencePathReference
        Description
        Evaluates to type of referenced field.
        valuestring
        string_literalStringLiteral
        Description
        Evaluates to string.
        valuestring
        number_literalNumberLiteral
        Description
        Evaluates to number.
        valuestring
        boolean_literalBooleanLiteral
        Description
        Evaluates to boolean.
        valueboolean
        is_missingIsMissing
        Description
        Evaluates to boolean.
        sourceExpression
        Max depth limit reached
        is_not_missingIsNotMissing
        Description
        Evaluates to boolean.
        sourceExpression
        Max depth limit reached
        false_or_missingFalseOrMissing
        Description
        Evaluates to boolean.
        sourceobject
        Description
        Must evaluate to boolean.
        Expression
        Max depth limit reached
        true_or_missingTrueOrMissing
        Description
        Evaluates to boolean.
        sourceobject
        Description
        Must evaluate to boolean.
        Expression
        Max depth limit reached
        coalesceCoalesce
        Description
        Evaluates to type of source.
        sourcesExpression[]
        Description
        Must all evaluate to same type.
        Max depth limit reached
        truncate_timeTruncateTime
        Description
        Evaluates to number (epoch seconds).
        sourceobject
        Description
        Must evaluate to a number (epoch seconds).
        Expression
        Max depth limit reached
        unitTimeUnit
        Default
        TIME_UNIT_NOT_SET
        Max depth limit reached
        timezoneobject
        Description
        Only required when unit = DAY, must evaluate to a string (IANA timezone name).
        Expression
        Max depth limit reached
        shift_timeShiftTime
        Description
        Evaluates to number (epoch seconds).
        sourceobject
        Description
        Must evaluate to a number (epoch seconds).
        Expression
        Max depth limit reached
        amountobject
        Description
        Must evaluate to a number (seconds).
        Expression
        Max depth limit reached
        unitTimeUnit
        Default
        TIME_UNIT_NOT_SET
        Max depth limit reached
        timezoneobject
        Description
        Only required when unit = DAY, must evaluate to a string (IANA timezone name).
        Expression
        Max depth limit reached
        any_of_stringAnyOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        any_of_numberAnyOfNumber
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        none_of_stringNoneOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        none_of_numberNoneOfNumber
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        like_any_of_stringLikeAnyOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        like_none_of_stringLikeNoneOfString
        Description
        Evaluates to boolean.
        needleExpression
        Max depth limit reached
        haystackstring[]
        is_list_memberIsListMember
        Description
        Evaluates to boolean.
        liststring
        is_not_list_memberIsNotListMember
        Description
        Evaluates to boolean.
        liststring
        tracked_dataTrackedData[]
        Description
        Optional.
        keyKey
        Description
        Must be unique within a SegmentDefinition.
        keystring
        source_pathstring
        Description
        Path to a source object, eg: event.product or event.product.parent_product.
        field_sub_pathsstring[]
        Description
        Within the source, set of field sub-paths, eg: (product_id, category.name_0).
        max_age_secondsinteger<int32>
        Description
        Must be between 1 and 2419200 (ie, 28 days).
        Format
        int32
        goalobject
        Description
        Optional.
        Continuation
        combinationContinuation.Combination
        conjunctionConjunction
        Default
        CONJUNCTION_NOT_SET
        Max depth limit reached
        continuationsContinuation[]
        Description
        Cannot be empty.
        Max depth limit reached
        event_filterobject
        Description
        Must evaluate to a boolean.
        Expression
        combinationExpression.Combination
        Description
        Evaluates to boolean.
        Max depth limit reached
        comparisonComparison
        Description
        Evaluates to boolean.
        Max depth limit reached
        path_referencePathReference
        Description
        Evaluates to type of referenced field.
        Max depth limit reached
        string_literalStringLiteral
        Description
        Evaluates to string.
        Max depth limit reached
        number_literalNumberLiteral
        Description
        Evaluates to number.
        Max depth limit reached
        boolean_literalBooleanLiteral
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_missingIsMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_not_missingIsNotMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        false_or_missingFalseOrMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        true_or_missingTrueOrMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        coalesceCoalesce
        Description
        Evaluates to type of source.
        Max depth limit reached
        truncate_timeTruncateTime
        Description
        Evaluates to number (epoch seconds).
        Max depth limit reached
        shift_timeShiftTime
        Description
        Evaluates to number (epoch seconds).
        Max depth limit reached
        any_of_stringAnyOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        any_of_numberAnyOfNumber
        Description
        Evaluates to boolean.
        Max depth limit reached
        none_of_stringNoneOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        none_of_numberNoneOfNumber
        Description
        Evaluates to boolean.
        Max depth limit reached
        like_any_of_stringLikeAnyOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        like_none_of_stringLikeNoneOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_list_memberIsListMember
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_not_list_memberIsNotListMember
        Description
        Evaluates to boolean.
        Max depth limit reached
        sequence_conditionSequenceCondition
        Circular-Reference
        timeout_sourceobject
        Description
        Computed at entry, must evaluate to a number (epoch seconds).
        Expression
        combinationExpression.Combination
        Description
        Evaluates to boolean.
        Max depth limit reached
        comparisonComparison
        Description
        Evaluates to boolean.
        Max depth limit reached
        path_referencePathReference
        Description
        Evaluates to type of referenced field.
        Max depth limit reached
        string_literalStringLiteral
        Description
        Evaluates to string.
        Max depth limit reached
        number_literalNumberLiteral
        Description
        Evaluates to number.
        Max depth limit reached
        boolean_literalBooleanLiteral
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_missingIsMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_not_missingIsNotMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        false_or_missingFalseOrMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        true_or_missingTrueOrMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        coalesceCoalesce
        Description
        Evaluates to type of source.
        Max depth limit reached
        truncate_timeTruncateTime
        Description
        Evaluates to number (epoch seconds).
        Max depth limit reached
        shift_timeShiftTime
        Description
        Evaluates to number (epoch seconds).
        Max depth limit reached
        any_of_stringAnyOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        any_of_numberAnyOfNumber
        Description
        Evaluates to boolean.
        Max depth limit reached
        none_of_stringNoneOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        none_of_numberNoneOfNumber
        Description
        Evaluates to boolean.
        Max depth limit reached
        like_any_of_stringLikeAnyOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        like_none_of_stringLikeNoneOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_list_memberIsListMember
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_not_list_memberIsNotListMember
        Description
        Evaluates to boolean.
        Max depth limit reached
        disqualifierobject
        Description
        Optional.
        Continuation
        combinationContinuation.Combination
        conjunctionConjunction
        Default
        CONJUNCTION_NOT_SET
        Max depth limit reached
        continuationsContinuation[]
        Description
        Cannot be empty.
        Max depth limit reached
        event_filterobject
        Description
        Must evaluate to a boolean.
        Expression
        combinationExpression.Combination
        Description
        Evaluates to boolean.
        Max depth limit reached
        comparisonComparison
        Description
        Evaluates to boolean.
        Max depth limit reached
        path_referencePathReference
        Description
        Evaluates to type of referenced field.
        Max depth limit reached
        string_literalStringLiteral
        Description
        Evaluates to string.
        Max depth limit reached
        number_literalNumberLiteral
        Description
        Evaluates to number.
        Max depth limit reached
        boolean_literalBooleanLiteral
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_missingIsMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_not_missingIsNotMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        false_or_missingFalseOrMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        true_or_missingTrueOrMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        coalesceCoalesce
        Description
        Evaluates to type of source.
        Max depth limit reached
        truncate_timeTruncateTime
        Description
        Evaluates to number (epoch seconds).
        Max depth limit reached
        shift_timeShiftTime
        Description
        Evaluates to number (epoch seconds).
        Max depth limit reached
        any_of_stringAnyOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        any_of_numberAnyOfNumber
        Description
        Evaluates to boolean.
        Max depth limit reached
        none_of_stringNoneOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        none_of_numberNoneOfNumber
        Description
        Evaluates to boolean.
        Max depth limit reached
        like_any_of_stringLikeAnyOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        like_none_of_stringLikeNoneOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_list_memberIsListMember
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_not_list_memberIsNotListMember
        Description
        Evaluates to boolean.
        Max depth limit reached
        sequence_conditionSequenceCondition
        Circular-Reference
        timeout_sourceobject
        Description
        Computed at entry, must evaluate to a number (epoch seconds).
        Expression
        combinationExpression.Combination
        Description
        Evaluates to boolean.
        Max depth limit reached
        comparisonComparison
        Description
        Evaluates to boolean.
        Max depth limit reached
        path_referencePathReference
        Description
        Evaluates to type of referenced field.
        Max depth limit reached
        string_literalStringLiteral
        Description
        Evaluates to string.
        Max depth limit reached
        number_literalNumberLiteral
        Description
        Evaluates to number.
        Max depth limit reached
        boolean_literalBooleanLiteral
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_missingIsMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_not_missingIsNotMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        false_or_missingFalseOrMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        true_or_missingTrueOrMissing
        Description
        Evaluates to boolean.
        Max depth limit reached
        coalesceCoalesce
        Description
        Evaluates to type of source.
        Max depth limit reached
        truncate_timeTruncateTime
        Description
        Evaluates to number (epoch seconds).
        Max depth limit reached
        shift_timeShiftTime
        Description
        Evaluates to number (epoch seconds).
        Max depth limit reached
        any_of_stringAnyOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        any_of_numberAnyOfNumber
        Description
        Evaluates to boolean.
        Max depth limit reached
        none_of_stringNoneOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        none_of_numberNoneOfNumber
        Description
        Evaluates to boolean.
        Max depth limit reached
        like_any_of_stringLikeAnyOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        like_none_of_stringLikeNoneOfString
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_list_memberIsListMember
        Description
        Evaluates to boolean.
        Max depth limit reached
        is_not_list_memberIsNotListMember
        Description
        Evaluates to boolean.
        Max depth limit reached
        min_countinteger<int32>
        Description
        Optional, but at least one of min_count or max_count should be specified.
        Format
        int32
        max_countinteger<int32>
        Description
        Optional, cannot be less than min_count.
        Format
        int32
  - externalobject
    Description
    Defines a passthrough audience whose membership is set by an external system through passthrough qualify and disqualify events. Mutually exclusive with root_condition.
    - ExternalDefinition
      - external_audience_idstring
        Description
        ID of the external audience. Must match the audience_id sent in passthrough qualify and disqualify events.
  - collectionsCollection[]
    - keystring
    - sourceKey
      Description
      Must be unique within a SegmentDefinition.
      - keystring
    - narrowed_sub_pathsstring[]
      Description
      Optional, a subset of the tracked data's sub-paths for narrowing the output.
    - uniqueboolean
      Description
      Only output unique rows.

Responses

200A successful response.

InstallSegmentResponse
Example
```
{
  "revision": 1
}
```
- revisioninteger<int32>
  Format
  int32

201Created.

InstallSegmentResponse
Example
```
{
  "revision": 1
}
```
- revisioninteger<int32>
  Format
  int32

400Bad Request.

undefined

curl

curl --request PUT \
     --url https://api.us1.odp.optimizely.com/v3/segments/{segment_id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'PUT',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.us1.odp.optimizely.com/v3/segments/{segment_id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.us1.odp.optimizely.com/v3/segments/{segment_id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.us1.odp.optimizely.com/v3/segments/{segment_id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

200

// A successful response.
{
  "revision": ""
}

201

// Created.
{
  "revision": ""
}

400

// Bad Request.
""