segment_summary

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/sendgrid/main/json-schema/sendgrid-segment-summary-schema.json",
  "title": "segment_summary",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sendgrid-segmenting-contacts-api-openapi.yml#/components/schemas/SegmentSummary",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 36,
      "maxLength": 36,
      "format": "uuid"
    },
    "contacts_count": {
      "type": "integer"
    },
    "created_at": {
      "type": "string",
      "description": "ISO8601 of created timestamp\n",
      "format": "date-time"
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "parent_list_id": {
      "type": "string",
      "minLength": 36,
      "maxLength": 36,
      "format": "uuid",
      "description": "The id of the list if this segment is a child of a list.  This implies the query `AND CONTAINS(list_ids, ${parent_list_id})`"
    },
    "sample_updated_at": {
      "type": "string",
      "description": "ISO8601 timestamp the sample was last updated",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "description": "ISO8601 timestamp the object was last updated",
      "format": "date-time"
    },
    "next_sample_update": {
      "type": "string",
      "description": "ISO8601 string that is equal to `sample_updated_at` plus an internally calculated offset that depends on how often contacts enter or exit segments as the scheduled pipeline updates the samples."
    }
  },
  "required": [
    "id",
    "contacts_count",
    "created_at",
    "sample_updated_at",
    "updated_at"
  ]
}