> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Segment Object

<div class="prose dark:prose-invert custom-html">
  <h2 id="segment">Segment</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            id

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Unique segment ID.</p>

          <p>
            <strong>Example:</strong>
            seg\_1wc52c5z6r1kQ81brO8j9Hk2
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            name

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Segment name.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            created\_at

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format.</p>

          <p>
            <strong>Example:</strong>
            2022-05-12T13:01:56.896Z
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            updated\_at

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Timestamp in ISO 8601 format indicating when the segment was updated.</p>

          <p>
            <strong>Example:</strong>
            2022-10-03T12:24:58.008Z
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            type

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Defines whether the segment is:</p>

          <ul>
            <li>
              Active (
              <code>auto-update</code>
              ): customers enter and leave the segment based on the defined filters and the
              <code>customer.segment.entered</code>
              and
              <code>customer.segment.left</code>
              events are triggered,
            </li>

            <li>
              Passive (
              <code>passive</code>
              ): customers enter and leave the segment based on the defined filters, but the
              <code>customer.segment.entered</code>
              and
              <code>customer.segment.left</code>
              events are not triggered,
            </li>

            <li>
              Static (
              <code>static</code>
              ): manually selected customers.
            </li>
          </ul>

          <p>
            Available values:
            <code>auto-update</code>,
            <code>passive</code>,
            <code>static</code>
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            filter

            <br />

            <code>object</code>,
            <code>null</code>
          </p>
        </td>

        <td>
          <p>
            Defines a set of criteria for an
            <code>auto-update</code>
            or
            <code>passive</code>
            segment type.
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            object

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>The type of the object represented by JSON. This object stores information about the customer segment.</p>

          <p>
            Available values:
            <code>segment</code>
          </p>
        </td>
      </tr>
    </tbody>
  </table>
</div>