HubSpot · JSON Structure

Source Code Api Action Response Structure

Response for asynchronous action status

Type: object Properties: 5 Required: 3
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

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

Properties

status requestedAt startedAt completedAt links

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/source-code-api-action-response-structure.json",
  "name": "ActionResponse",
  "description": "Response for asynchronous action status",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Current status of the action",
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ],
      "example": "COMPLETE"
    },
    "requestedAt": {
      "type": "datetime",
      "description": "When the action was requested",
      "example": "2024-01-15T10:30:00Z"
    },
    "startedAt": {
      "type": "datetime",
      "description": "When the action started processing",
      "example": "2024-01-15T10:30:01Z"
    },
    "completedAt": {
      "type": "datetime",
      "description": "When the action completed",
      "example": "2024-01-15T10:30:15Z"
    },
    "links": {
      "type": "object",
      "description": "Related links",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value"
      }
    }
  },
  "required": [
    "status",
    "startedAt",
    "completedAt"
  ]
}