Iterable · Schema

IterableResponse

Standard Iterable API response indicating success or failure

Cross-Channel MessagingCustomer EngagementEmailMarketing AutomationPush NotificationsSMS

Properties

Name Type Description
msg string Human-readable response message
code string Response code indicating success or error type
params object Additional response parameters
View JSON Schema on GitHub

JSON Schema

iterable-iterableresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IterableResponse",
  "title": "IterableResponse",
  "type": "object",
  "description": "Standard Iterable API response indicating success or failure",
  "properties": {
    "msg": {
      "type": "string",
      "description": "Human-readable response message"
    },
    "code": {
      "type": "string",
      "description": "Response code indicating success or error type"
    },
    "params": {
      "type": "object",
      "description": "Additional response parameters",
      "additionalProperties": true
    }
  }
}