HubSpot · JSON Structure

Conversations Api Inbox Structure

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

Type: object Properties: 6 Required: 4
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Inbox is a JSON Structure definition published by HubSpot, describing 6 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name type createdAt updatedAt archived

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/conversations-api-inbox-structure.json",
  "name": "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": "datetime",
      "description": "ISO 8601 timestamp when the inbox was created",
      "example": "2024-01-10T09:00:00Z"
    },
    "updatedAt": {
      "type": "datetime",
      "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"
  ]
}