Common Room · Schema

Status

Community IntelligenceGo-to-MarketMember SignalsGitHubSlackDiscordLinkedInSales IntelligenceContact ManagementWebhooks

Properties

Name Type Description
status string
reason string
errors array
View JSON Schema on GitHub

JSON Schema

common-room-core-status-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.commonroom.io/schemas/core/status",
  "title": "Status",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ok",
        "failure",
        "not-found"
      ],
      "example": "success"
    },
    "reason": {
      "type": "string"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "required": [
        "status"
      ]
    }
  },
  "example": {
    "status": "not created",
    "errors": [
      "name is missing"
    ]
  }
}