Common Room · Schema

CreateSegmentResponse

Community IntelligenceGo-to-MarketMember SignalsGitHubSlackDiscordLinkedInSales IntelligenceContact ManagementWebhooks

Properties

Name Type Description
success boolean
data object
View JSON Schema on GitHub

JSON Schema

common-room-v2-createsegmentresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.commonroom.io/schemas/v2/createsegmentresponse",
  "title": "CreateSegmentResponse",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "data": {
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Prefixed segment ID (format `s_<number>`)"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}