HubSpot · Schema
ActionResponse
Response for asynchronous action status
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales
Properties
| Name | Type | Description |
|---|---|---|
| status | string | Current status of the action |
| requestedAt | string | When the action was requested |
| startedAt | string | When the action started processing |
| completedAt | string | When the action completed |
| links | object | Related links |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/source-code-api-action-response-schema.json",
"title": "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": "string",
"format": "date-time",
"description": "When the action was requested",
"example": "2024-01-15T10:30:00Z"
},
"startedAt": {
"type": "string",
"format": "date-time",
"description": "When the action started processing",
"example": "2024-01-15T10:30:01Z"
},
"completedAt": {
"type": "string",
"format": "date-time",
"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"
]
}