HubSpot · Schema

Inbox

Represents a conversation inbox configuration where messages are organized and routed.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
id string Unique identifier for the inbox
name string Display name of the inbox
type string Type of inbox (e.g., CONVERSATIONS_INBOX)
createdAt string ISO 8601 timestamp when the inbox was created
updatedAt string ISO 8601 timestamp when the inbox was last updated
archived boolean Whether the inbox is archived
View JSON Schema on GitHub

JSON Schema

conversations-api-inbox-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/conversations-api-inbox-schema.json",
  "title": "Inbox",
  "description": "Represents a conversation inbox configuration where messages are organized and routed.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the inbox",
      "example": "12345678"
    },
    "name": {
      "type": "string",
      "description": "Display name of the inbox",
      "example": "Support Inbox"
    },
    "type": {
      "type": "string",
      "description": "Type of inbox (e.g., CONVERSATIONS_INBOX)",
      "example": "CONVERSATIONS_INBOX"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the inbox was created",
      "example": "2024-01-10T09:00:00Z"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the inbox was last updated",
      "example": "2024-01-15T14:30:00Z"
    },
    "archived": {
      "type": "boolean",
      "description": "Whether the inbox is archived",
      "example": false
    }
  },
  "required": [
    "id",
    "name",
    "createdAt",
    "updatedAt"
  ]
}