{ "openapi": "3.1.0", "info": { "title": "Inaiy Public API", "version": "1.1.0", "description": "# Inaiy Public API\n\nProgrammatic access to the Inaiy WhatsApp platform for third-party integrations.\n\n## Authentication\nAll requests require the `x-tenant-id` header (your workspace), plus one of:\n- **API key** — send `x-api-key: wp_live_...` (or `Authorization: Bearer wp_live_...`). Full-access, scope-exempt.\n- **OAuth 2.0 access token** — send `Authorization: Bearer wp_at_...`. Scope-enforced per endpoint.\n\n## Rate limits\nRequests are rate limited per API key (falling back to client IP). Exceeding the limit returns `429` with a standard error envelope.\n\n## Response envelope\nSuccess: `{ \"success\": true, \"data\": ..., \"meta\": { \"apiVersion\": \"v1\" }, \"requestId\", \"timestamp\" }`.\nErrors: `{ \"success\": false, \"error\": { \"code\", \"message\", \"details\" }, \"requestId\", \"timestamp\", \"path\", \"method\" }`.", "contact": { "name": "PennaiAppz" }, "x-api-version": "v1", "x-release-date": "2026-07-12" }, "servers": [ { "url": "https://api.inaiy.com", "description": "Production" } ], "tags": [ { "name": "Public API - Contacts", "description": "Create, read, update, and delete contacts for the authenticated tenant." }, { "name": "Public API - Conversations", "description": "List, read, and update conversations." }, { "name": "Public API - Messages", "description": "List and read messages, and send new messages (queued for delivery)." }, { "name": "Public API - Templates", "description": "Read approved WhatsApp message templates." }, { "name": "Public API - Broadcasts", "description": "Create, manage, execute, and analyze broadcast campaigns." }, { "name": "Public API - Catalog", "description": "Upsert commerce catalog products into Inaiy (source of truth before WhatsApp publish)." }, { "name": "Public API - Media", "description": "Upload media for outbound messages and download pending uploads." }, { "name": "Public API - Team", "description": "Read agents and teams so you can assign conversations." }, { "name": "Public API - Analytics", "description": "Messaging, template, broadcast, inbox, commerce, drip, AI agent and API usage reports." }, { "name": "OAuth 2.0", "description": "OAuth 2.0 authorization server endpoints (authorize, token, revoke, introspect, userinfo)." }, { "name": "Webhooks", "description": "Outbound webhook events delivered to your subscribed endpoints." } ], "x-tagGroups": [ { "name": "Public REST API", "tags": [ "Public API - Contacts", "Public API - Conversations", "Public API - Messages", "Public API - Templates", "Public API - Media", "Public API - Broadcasts", "Public API - Catalog", "Public API - Team", "Public API - Analytics" ] }, { "name": "Authorization", "tags": [ "OAuth 2.0" ] }, { "name": "Webhooks", "tags": [ "Webhooks" ] } ], "components": { "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "API key (wp_live_ / wp_test_). Full-access, scope-exempt. Also accepted as `Authorization: Bearer `." }, "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "Opaque", "description": "OAuth 2.0 access token (wp_at_...). Scope-enforced per endpoint." }, "oauth2": { "type": "oauth2", "description": "OAuth 2.0 flows. Authorization Code (+PKCE) for user-facing apps; Client Credentials for server-to-server.", "flows": { "authorizationCode": { "authorizationUrl": "/oauth/authorize", "tokenUrl": "/oauth/token", "scopes": { "contacts.read": "View contacts and their details.", "contacts.write": "Create, update, and delete contacts.", "conversations.read": "View conversations and their metadata.", "conversations.write": "Update, assign, and modify conversations.", "messages.read": "View messages within conversations.", "messages.write": "Send messages on your behalf.", "media.read": "View and download uploaded media files.", "media.write": "Upload media files for messages and template headers.", "templates.read": "View approved message templates.", "broadcasts.read": "View broadcast campaigns and their status.", "broadcasts.write": "Create and manage broadcast campaigns.", "catalog.write": "Create and update commerce catalog products via the Public API.", "channels.read": "View connected WhatsApp, Instagram, and Messenger channels.", "team.read": "View agents and teams in the workspace.", "analytics.read": "View messaging, template, broadcast, inbox, commerce, drip, AI agent, Public API usage, and plan usage analytics.", "webhooks.read": "Reserved for the upcoming webhook management API; no Public API endpoint uses it yet.", "webhooks.write": "Reserved for the upcoming webhook management API; no Public API endpoint uses it yet." } }, "clientCredentials": { "tokenUrl": "/oauth/token", "scopes": { "contacts.read": "View contacts and their details.", "contacts.write": "Create, update, and delete contacts.", "conversations.read": "View conversations and their metadata.", "conversations.write": "Update, assign, and modify conversations.", "messages.read": "View messages within conversations.", "messages.write": "Send messages on your behalf.", "media.read": "View and download uploaded media files.", "media.write": "Upload media files for messages and template headers.", "templates.read": "View approved message templates.", "broadcasts.read": "View broadcast campaigns and their status.", "broadcasts.write": "Create and manage broadcast campaigns.", "catalog.write": "Create and update commerce catalog products via the Public API.", "channels.read": "View connected WhatsApp, Instagram, and Messenger channels.", "team.read": "View agents and teams in the workspace.", "analytics.read": "View messaging, template, broadcast, inbox, commerce, drip, AI agent, Public API usage, and plan usage analytics.", "webhooks.read": "Reserved for the upcoming webhook management API; no Public API endpoint uses it yet.", "webhooks.write": "Reserved for the upcoming webhook management API; no Public API endpoint uses it yet." } } } } }, "schemas": {}, "responses": { "Error400": { "description": "Bad Request — The request was malformed or the tenant context headers are missing.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "string", "null" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "string", "null" ] }, "method": { "type": [ "string", "null" ] } } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "Error401": { "description": "Unauthorized — The API key or OAuth access token is missing, malformed, or invalid.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "string", "null" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "string", "null" ] }, "method": { "type": [ "string", "null" ] } } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "Error403": { "description": "Forbidden — The developer platform is disabled, the credential lacks the required scope, or the tenant does not match.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "string", "null" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "string", "null" ] }, "method": { "type": [ "string", "null" ] } } }, "example": { "success": false, "error": { "code": "OAUTH_INSUFFICIENT_SCOPE", "message": "The access token does not have the required scope: contacts.write.", "details": { "requiredScope": "contacts.write" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "Error404": { "description": "Not Found — The requested resource does not exist (or is not visible to this tenant).", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "string", "null" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "string", "null" ] }, "method": { "type": [ "string", "null" ] } } }, "example": { "success": false, "error": { "code": "CONTACT_NOT_FOUND", "message": "Contact not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "Error409": { "description": "Conflict — The request conflicts with the current state, e.g. a duplicate unique value.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "string", "null" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "string", "null" ] }, "method": { "type": [ "string", "null" ] } } }, "example": { "success": false, "error": { "code": "DUPLICATE_PHONE", "message": "A contact with this phone number already exists.", "details": { "existingContactId": "6650a1b2c3d4e5f6a7b8c9d0" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "Error422": { "description": "Unprocessable Entity — Validation failed for one or more fields.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "string", "null" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "string", "null" ] }, "method": { "type": [ "string", "null" ] } } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "phone" ], "message": "Invalid phone number format" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "Error429": { "description": "Too Many Requests — The rate limit for this API key (or IP) was exceeded.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "string", "null" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "string", "null" ] }, "method": { "type": [ "string", "null" ] } } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": { "limit": 100, "remainingMs": 4200 } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "Error500": { "description": "Internal Server Error — An unexpected error occurred on the server.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "string", "null" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "string", "null" ] }, "method": { "type": [ "string", "null" ] } } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } } } }, "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] }, { "oauth2": [] } ], "paths": { "/api/public/v1/contacts": { "get": { "summary": "List contacts", "tags": [ "Public API - Contacts" ], "description": "Returns a paginated, filterable, sortable list of contacts for the authenticated tenant.", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "default": 1, "example": 1 }, "in": "query", "name": "page", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25, "example": 25 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "enum": [ "createdAt", "name", "phone", "email", "country", "updatedAt", "lastContactedAt", "source" ], "default": "createdAt" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "string", "example": "jane" }, "in": "query", "name": "search", "required": false, "description": "Matches name, phone, or email." }, { "schema": { "type": "string", "example": "vip,newsletter" }, "in": "query", "name": "label", "required": false, "description": "Comma-separated label/tag filter." }, { "schema": { "type": "string", "enum": [ "active", "deleted", "blocked", "merged" ], "default": "active" }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "example": "US" }, "in": "query", "name": "country", "required": false }, { "schema": { "type": "string", "enum": [ "manual", "import", "api", "whatsapp", "web" ] }, "in": "query", "name": "source", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "createdAfter", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "createdBefore", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "updatedAfter", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "updatedBefore", "required": false }, { "schema": { "type": "string", "example": "id,name,phone" }, "in": "query", "name": "fields", "required": false }, { "schema": { "type": "string", "example": "demo" }, "in": "header", "name": "x-tenant-id", "required": true, "description": "Tenant subdomain or MongoDB ObjectId (required)." }, { "schema": { "type": "string", "example": "Bearer wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "authorization", "required": false, "description": "API key as `Bearer `. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Paginated list of contacts", "content": { "application/json": { "schema": { "description": "Paginated list of contacts", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "name": { "type": "string", "example": "Jane Doe" }, "phone": { "type": "string", "example": "+14155552671" }, "email": { "type": [ "null", "string" ], "example": "jane@example.com" }, "country": { "type": [ "null", "string" ], "example": "US" }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "vip", "newsletter" ] }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "fieldId": { "type": [ "null", "string" ] }, "fieldName": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "value": {} } } }, "source": { "type": "string", "enum": [ "manual", "import", "api", "whatsapp", "web" ], "example": "api" }, "status": { "type": "string", "enum": [ "active", "deleted", "blocked", "merged" ], "example": "active" }, "isFavorite": { "type": "boolean", "example": false }, "isBlocked": { "type": "boolean", "example": false }, "marketingOptIn": { "type": "boolean", "example": true }, "marketingOptInAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastContactedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } }, "pagination": { "type": "object", "additionalProperties": true, "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 137 }, "totalPages": { "type": "integer", "example": 6 }, "hasNextPage": { "type": "boolean", "example": true }, "hasPrevPage": { "type": "boolean", "example": false }, "nextCursor": { "type": [ "null", "string" ], "example": null }, "prevCursor": { "type": [ "null", "string" ], "example": null } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": [ { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" } ], "pagination": { "page": 1, "limit": 25, "total": 137, "totalPages": 6, "hasNextPage": true, "hasPrevPage": false, "nextCursor": null, "prevCursor": null }, "meta": { "apiVersion": "v1", "sort": { "field": "createdAt", "direction": "desc" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": [ { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" } ], "pagination": { "page": 1, "limit": 25, "total": 137, "totalPages": 6, "hasNextPage": true, "hasPrevPage": false, "nextCursor": null, "prevCursor": null }, "meta": { "apiVersion": "v1", "sort": { "field": "createdAt", "direction": "desc" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "403": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "phone" ], "message": "Invalid phone number format" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "phone" ], "message": "Invalid phone number format" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/contacts\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/contacts\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/contacts\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "201": { "description": "Contact created", "content": { "application/json": { "schema": { "description": "Contact created", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "name": { "type": "string", "example": "Jane Doe" }, "phone": { "type": "string", "example": "+14155552671" }, "email": { "type": [ "null", "string" ], "example": "jane@example.com" }, "country": { "type": [ "null", "string" ], "example": "US" }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "vip", "newsletter" ] }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "fieldId": { "type": [ "null", "string" ] }, "fieldName": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "value": {} } } }, "source": { "type": "string", "enum": [ "manual", "import", "api", "whatsapp", "web" ], "example": "api" }, "status": { "type": "string", "enum": [ "active", "deleted", "blocked", "merged" ], "example": "active" }, "isFavorite": { "type": "boolean", "example": false }, "isBlocked": { "type": "boolean", "example": false }, "marketingOptIn": { "type": "boolean", "example": true }, "marketingOptInAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastContactedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ], "example": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11" }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "403": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "404": { "description": "Contact not found", "content": { "application/json": { "schema": { "description": "Contact not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CONTACT_NOT_FOUND", "message": "Contact not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CONTACT_NOT_FOUND", "message": "Contact not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "409": { "description": "Duplicate contact (phone already exists)", "content": { "application/json": { "schema": { "description": "Duplicate contact (phone already exists)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DUPLICATE_PHONE", "message": "A contact with this phone number already exists.", "details": { "existingContactId": "6650a1b2c3d4e5f6a7b8c9d0" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DUPLICATE_PHONE", "message": "A contact with this phone number already exists.", "details": { "existingContactId": "6650a1b2c3d4e5f6a7b8c9d0" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "phone" ], "message": "Invalid phone number format" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "phone" ], "message": "Invalid phone number format" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X POST \"https://api.inaiy.com/api/public/v1/contacts\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"name\":\"Jane Doe\",\"phone\":\"+14155552671\",\"email\":\"jane@example.com\",\"country\":\"US\",\"tags\":[\"vip\"],\"marketingOptIn\":true}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"name\": \"Jane Doe\",\n \"phone\": \"+14155552671\",\n \"email\": \"jane@example.com\",\n \"country\": \"US\",\n \"tags\": [\n \"vip\"\n ],\n \"marketingOptIn\": true\n })\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"name\": \"Jane Doe\",\n \"phone\": \"+14155552671\",\n \"email\": \"jane@example.com\",\n \"country\": \"US\",\n \"tags\": [\n \"vip\"\n ],\n \"marketingOptIn\": true\n })\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\npayload = {\n \"name\": \"Jane Doe\",\n \"phone\": \"+14155552671\",\n \"email\": \"jane@example.com\",\n \"country\": \"US\",\n \"tags\": [\n \"vip\"\n ],\n \"marketingOptIn\": True\n}\nres = requests.post(\"https://api.inaiy.com/api/public/v1/contacts\", headers=headers, json=payload)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/contacts\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .header(\"Content-Type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"name\\\":\\\"Jane Doe\\\",\\\"phone\\\":\\\"+14155552671\\\",\\\"email\\\":\\\"jane@example.com\\\",\\\"country\\\":\\\"US\\\",\\\"tags\\\":[\\\"vip\\\"],\\\"marketingOptIn\\\":true}\"))\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "The contact", "content": { "application/json": { "schema": { "description": "The contact", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "name": { "type": "string", "example": "Jane Doe" }, "phone": { "type": "string", "example": "+14155552671" }, "email": { "type": [ "null", "string" ], "example": "jane@example.com" }, "country": { "type": [ "null", "string" ], "example": "US" }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "vip", "newsletter" ] }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "fieldId": { "type": [ "null", "string" ] }, "fieldName": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "value": {} } } }, "source": { "type": "string", "enum": [ "manual", "import", "api", "whatsapp", "web" ], "example": "api" }, "status": { "type": "string", "enum": [ "active", "deleted", "blocked", "merged" ], "example": "active" }, "isFavorite": { "type": "boolean", "example": false }, "isBlocked": { "type": "boolean", "example": false }, "marketingOptIn": { "type": "boolean", "example": true }, "marketingOptInAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastContactedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ], "example": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11" }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "403": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "404": { "description": "Contact not found", "content": { "application/json": { "schema": { "description": "Contact not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CONTACT_NOT_FOUND", "message": "Contact not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CONTACT_NOT_FOUND", "message": "Contact not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "phone" ], "message": "Invalid phone number format" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "phone" ], "message": "Invalid phone number format" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/contacts/lookup\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts/lookup\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts/lookup\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/contacts/lookup\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/contacts/lookup\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "The contact", "content": { "application/json": { "schema": { "description": "The contact", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "name": { "type": "string", "example": "Jane Doe" }, "phone": { "type": "string", "example": "+14155552671" }, "email": { "type": [ "null", "string" ], "example": "jane@example.com" }, "country": { "type": [ "null", "string" ], "example": "US" }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "vip", "newsletter" ] }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "fieldId": { "type": [ "null", "string" ] }, "fieldName": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "value": {} } } }, "source": { "type": "string", "enum": [ "manual", "import", "api", "whatsapp", "web" ], "example": "api" }, "status": { "type": "string", "enum": [ "active", "deleted", "blocked", "merged" ], "example": "active" }, "isFavorite": { "type": "boolean", "example": false }, "isBlocked": { "type": "boolean", "example": false }, "marketingOptIn": { "type": "boolean", "example": true }, "marketingOptInAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastContactedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ], "example": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11" }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "403": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "404": { "description": "Contact not found", "content": { "application/json": { "schema": { "description": "Contact not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CONTACT_NOT_FOUND", "message": "Contact not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CONTACT_NOT_FOUND", "message": "Contact not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Contact updated", "content": { "application/json": { "schema": { "description": "Contact updated", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "name": { "type": "string", "example": "Jane Doe" }, "phone": { "type": "string", "example": "+14155552671" }, "email": { "type": [ "null", "string" ], "example": "jane@example.com" }, "country": { "type": [ "null", "string" ], "example": "US" }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "vip", "newsletter" ] }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "fieldId": { "type": [ "null", "string" ] }, "fieldName": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "value": {} } } }, "source": { "type": "string", "enum": [ "manual", "import", "api", "whatsapp", "web" ], "example": "api" }, "status": { "type": "string", "enum": [ "active", "deleted", "blocked", "merged" ], "example": "active" }, "isFavorite": { "type": "boolean", "example": false }, "isBlocked": { "type": "boolean", "example": false }, "marketingOptIn": { "type": "boolean", "example": true }, "marketingOptInAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastContactedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ], "example": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11" }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "403": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "404": { "description": "Contact not found", "content": { "application/json": { "schema": { "description": "Contact not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CONTACT_NOT_FOUND", "message": "Contact not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CONTACT_NOT_FOUND", "message": "Contact not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "409": { "description": "Duplicate contact (phone already exists)", "content": { "application/json": { "schema": { "description": "Duplicate contact (phone already exists)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DUPLICATE_PHONE", "message": "A contact with this phone number already exists.", "details": { "existingContactId": "6650a1b2c3d4e5f6a7b8c9d0" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DUPLICATE_PHONE", "message": "A contact with this phone number already exists.", "details": { "existingContactId": "6650a1b2c3d4e5f6a7b8c9d0" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "phone" ], "message": "Invalid phone number format" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "phone" ], "message": "Invalid phone number format" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X PATCH \"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"name\":\"Jane A. Doe\",\"tags\":[\"vip\",\"priority\"]}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"PATCH\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"name\": \"Jane A. Doe\",\n \"tags\": [\n \"vip\",\n \"priority\"\n ]\n })\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"PATCH\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"name\": \"Jane A. Doe\",\n \"tags\": [\n \"vip\",\n \"priority\"\n ]\n })\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\npayload = {\n \"name\": \"Jane A. Doe\",\n \"tags\": [\n \"vip\",\n \"priority\"\n ]\n}\nres = requests.patch(\"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers, json=payload)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .header(\"Content-Type\", \"application/json\")\n .method(\"PATCH\", HttpRequest.BodyPublishers.ofString(\"{\\\"name\\\":\\\"Jane A. Doe\\\",\\\"tags\\\":[\\\"vip\\\",\\\"priority\\\"]}\"))\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "204": { "description": "Contact deleted" }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "403": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "404": { "description": "Contact not found", "content": { "application/json": { "schema": { "description": "Contact not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CONTACT_NOT_FOUND", "message": "Contact not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CONTACT_NOT_FOUND", "message": "Contact not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X DELETE \"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"DELETE\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"DELETE\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.delete(\"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/contacts/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"DELETE\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Existing contact updated (meta.created = false)", "content": { "application/json": { "schema": { "description": "Existing contact updated (meta.created = false)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "name": { "type": "string", "example": "Jane Doe" }, "phone": { "type": "string", "example": "+14155552671" }, "email": { "type": [ "null", "string" ], "example": "jane@example.com" }, "country": { "type": [ "null", "string" ], "example": "US" }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "vip", "newsletter" ] }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "fieldId": { "type": [ "null", "string" ] }, "fieldName": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "value": {} } } }, "source": { "type": "string", "enum": [ "manual", "import", "api", "whatsapp", "web" ], "example": "api" }, "status": { "type": "string", "enum": [ "active", "deleted", "blocked", "merged" ], "example": "active" }, "isFavorite": { "type": "boolean", "example": false }, "isBlocked": { "type": "boolean", "example": false }, "marketingOptIn": { "type": "boolean", "example": true }, "marketingOptInAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastContactedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ], "example": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11" }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "201": { "description": "Contact created (meta.created = true)", "content": { "application/json": { "schema": { "description": "Contact created (meta.created = true)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "name": { "type": "string", "example": "Jane Doe" }, "phone": { "type": "string", "example": "+14155552671" }, "email": { "type": [ "null", "string" ], "example": "jane@example.com" }, "country": { "type": [ "null", "string" ], "example": "US" }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "vip", "newsletter" ] }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "fieldId": { "type": [ "null", "string" ] }, "fieldName": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "value": {} } } }, "source": { "type": "string", "enum": [ "manual", "import", "api", "whatsapp", "web" ], "example": "api" }, "status": { "type": "string", "enum": [ "active", "deleted", "blocked", "merged" ], "example": "active" }, "isFavorite": { "type": "boolean", "example": false }, "isBlocked": { "type": "boolean", "example": false }, "marketingOptIn": { "type": "boolean", "example": true }, "marketingOptInAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastContactedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ], "example": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11" }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com", "country": "US", "tags": [ "vip", "newsletter" ], "customFields": [ { "fieldId": "664f...", "fieldName": "Company", "type": "text", "value": "Acme Inc" } ], "source": "api", "status": "active", "isFavorite": false, "isBlocked": false, "marketingOptIn": true, "marketingOptInAt": "2026-07-12T09:30:00.000Z", "lastContactedAt": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "403": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "404": { "description": "Contact not found", "content": { "application/json": { "schema": { "description": "Contact not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CONTACT_NOT_FOUND", "message": "Contact not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CONTACT_NOT_FOUND", "message": "Contact not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "phone" ], "message": "Invalid phone number format" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "phone" ], "message": "Invalid phone number format" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/contacts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X POST \"https://api.inaiy.com/api/public/v1/contacts/upsert\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"phone\":\"+14155552671\",\"name\":\"Jane Doe\",\"tags\":[\"vip\"]}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts/upsert\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"phone\": \"+14155552671\",\n \"name\": \"Jane Doe\",\n \"tags\": [\n \"vip\"\n ]\n })\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/contacts/upsert\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"phone\": \"+14155552671\",\n \"name\": \"Jane Doe\",\n \"tags\": [\n \"vip\"\n ]\n })\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\npayload = {\n \"phone\": \"+14155552671\",\n \"name\": \"Jane Doe\",\n \"tags\": [\n \"vip\"\n ]\n}\nres = requests.post(\"https://api.inaiy.com/api/public/v1/contacts/upsert\", headers=headers, json=payload)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/contacts/upsert\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .header(\"Content-Type\", \"application/json\")\n .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"phone\\\":\\\"+14155552671\\\",\\\"name\\\":\\\"Jane Doe\\\",\\\"tags\\\":[\\\"vip\\\"]}\"))\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Paginated list of conversations", "content": { "application/json": { "schema": { "description": "Paginated list of conversations", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "contactId": { "type": [ "null", "string" ], "example": "664fa1b2c3d4e5f6a7b8c9d0" }, "channelId": { "type": [ "null", "string" ], "example": "663fa1b2c3d4e5f6a7b8c9d0" }, "assignedAgentId": { "type": [ "null", "string" ], "example": "662fa1b2c3d4e5f6a7b8c9d0" }, "status": { "type": "string", "enum": [ "open", "pending", "resolved", "closed", "archived" ], "example": "open" }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ], "example": "medium" }, "isArchived": { "type": "boolean", "example": false }, "labelIds": { "type": "array", "items": { "type": "string" }, "example": [ "661fa1b2c3d4e5f6a7b8c9d0" ] }, "labels": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "color": { "type": [ "null", "string" ] } } } }, "unreadCount": { "type": "integer", "example": 2 }, "lastMessagePreview": { "type": [ "null", "string" ], "example": "See you tomorrow!" }, "lastMessageAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastMessageDirection": { "type": [ "null", "string" ], "example": "inbound" }, "isPinned": { "type": "boolean", "example": false }, "isMuted": { "type": "boolean", "example": false }, "isResolved": { "type": "boolean", "example": false }, "startedAt": { "type": [ "null", "string" ], "format": "date-time" }, "resolvedAt": { "type": [ "null", "string" ], "format": "date-time" }, "closedAt": { "type": [ "null", "string" ], "format": "date-time" }, "source": { "type": [ "null", "string" ], "example": "whatsapp" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "contact": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] } } }, "channel": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] } } }, "assignedAgent": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": [ "null", "string" ] }, "fullName": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] } } } } } }, "pagination": { "type": "object", "additionalProperties": true, "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 137 }, "totalPages": { "type": "integer", "example": 6 }, "hasNextPage": { "type": "boolean", "example": true }, "hasPrevPage": { "type": "boolean", "example": false }, "nextCursor": { "type": [ "null", "string" ], "example": null }, "prevCursor": { "type": [ "null", "string" ], "example": null } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": [ { "id": "6650a1b2c3d4e5f6a7b8c9d0", "contactId": "664fa1b2c3d4e5f6a7b8c9d0", "channelId": "663fa1b2c3d4e5f6a7b8c9d0", "assignedAgentId": "662fa1b2c3d4e5f6a7b8c9d0", "status": "open", "priority": "medium", "isArchived": false, "labelIds": [ "661fa1b2c3d4e5f6a7b8c9d0" ], "labels": [ { "id": "661fa1b2c3d4e5f6a7b8c9d0", "name": "VIP", "color": "#6366f1" } ], "unreadCount": 2, "lastMessagePreview": "See you tomorrow!", "lastMessageAt": "2026-07-12T09:30:00.000Z", "lastMessageDirection": "inbound", "isPinned": false, "isMuted": false, "isResolved": false, "startedAt": "2026-07-10T08:00:00.000Z", "resolvedAt": null, "closedAt": null, "source": "whatsapp", "createdAt": "2026-07-10T08:00:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z", "contact": { "id": "664fa1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com" }, "channel": { "id": "663fa1b2c3d4e5f6a7b8c9d0", "name": "Main WhatsApp", "type": "whatsapp" }, "assignedAgent": { "id": "662fa1b2c3d4e5f6a7b8c9d0", "fullName": "Alex Agent", "email": "alex@company.com" } } ], "pagination": { "page": 1, "limit": 25, "total": 137, "totalPages": 6, "hasNextPage": true, "hasPrevPage": false, "nextCursor": null, "prevCursor": null }, "meta": { "apiVersion": "v1", "sort": { "field": "lastMessageAt", "order": "desc" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": [ { "id": "6650a1b2c3d4e5f6a7b8c9d0", "contactId": "664fa1b2c3d4e5f6a7b8c9d0", "channelId": "663fa1b2c3d4e5f6a7b8c9d0", "assignedAgentId": "662fa1b2c3d4e5f6a7b8c9d0", "status": "open", "priority": "medium", "isArchived": false, "labelIds": [ "661fa1b2c3d4e5f6a7b8c9d0" ], "labels": [ { "id": "661fa1b2c3d4e5f6a7b8c9d0", "name": "VIP", "color": "#6366f1" } ], "unreadCount": 2, "lastMessagePreview": "See you tomorrow!", "lastMessageAt": "2026-07-12T09:30:00.000Z", "lastMessageDirection": "inbound", "isPinned": false, "isMuted": false, "isResolved": false, "startedAt": "2026-07-10T08:00:00.000Z", "resolvedAt": null, "closedAt": null, "source": "whatsapp", "createdAt": "2026-07-10T08:00:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z", "contact": { "id": "664fa1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com" }, "channel": { "id": "663fa1b2c3d4e5f6a7b8c9d0", "name": "Main WhatsApp", "type": "whatsapp" }, "assignedAgent": { "id": "662fa1b2c3d4e5f6a7b8c9d0", "fullName": "Alex Agent", "email": "alex@company.com" } } ], "pagination": { "page": 1, "limit": 25, "total": 137, "totalPages": 6, "hasNextPage": true, "hasPrevPage": false, "nextCursor": null, "prevCursor": null }, "meta": { "apiVersion": "v1", "sort": { "field": "lastMessageAt", "order": "desc" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "403": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "status" ], "message": "Invalid enum value." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "status" ], "message": "Invalid enum value." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/conversations\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/conversations\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/conversations\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/conversations\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/conversations\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "The conversation", "content": { "application/json": { "schema": { "description": "The conversation", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "contactId": { "type": [ "null", "string" ], "example": "664fa1b2c3d4e5f6a7b8c9d0" }, "channelId": { "type": [ "null", "string" ], "example": "663fa1b2c3d4e5f6a7b8c9d0" }, "assignedAgentId": { "type": [ "null", "string" ], "example": "662fa1b2c3d4e5f6a7b8c9d0" }, "status": { "type": "string", "enum": [ "open", "pending", "resolved", "closed", "archived" ], "example": "open" }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ], "example": "medium" }, "isArchived": { "type": "boolean", "example": false }, "labelIds": { "type": "array", "items": { "type": "string" }, "example": [ "661fa1b2c3d4e5f6a7b8c9d0" ] }, "labels": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "color": { "type": [ "null", "string" ] } } } }, "unreadCount": { "type": "integer", "example": 2 }, "lastMessagePreview": { "type": [ "null", "string" ], "example": "See you tomorrow!" }, "lastMessageAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastMessageDirection": { "type": [ "null", "string" ], "example": "inbound" }, "isPinned": { "type": "boolean", "example": false }, "isMuted": { "type": "boolean", "example": false }, "isResolved": { "type": "boolean", "example": false }, "startedAt": { "type": [ "null", "string" ], "format": "date-time" }, "resolvedAt": { "type": [ "null", "string" ], "format": "date-time" }, "closedAt": { "type": [ "null", "string" ], "format": "date-time" }, "source": { "type": [ "null", "string" ], "example": "whatsapp" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "contact": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] } } }, "channel": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] } } }, "assignedAgent": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": [ "null", "string" ] }, "fullName": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] } } } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ], "example": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11" }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "contactId": "664fa1b2c3d4e5f6a7b8c9d0", "channelId": "663fa1b2c3d4e5f6a7b8c9d0", "assignedAgentId": "662fa1b2c3d4e5f6a7b8c9d0", "status": "open", "priority": "medium", "isArchived": false, "labelIds": [ "661fa1b2c3d4e5f6a7b8c9d0" ], "labels": [ { "id": "661fa1b2c3d4e5f6a7b8c9d0", "name": "VIP", "color": "#6366f1" } ], "unreadCount": 2, "lastMessagePreview": "See you tomorrow!", "lastMessageAt": "2026-07-12T09:30:00.000Z", "lastMessageDirection": "inbound", "isPinned": false, "isMuted": false, "isResolved": false, "startedAt": "2026-07-10T08:00:00.000Z", "resolvedAt": null, "closedAt": null, "source": "whatsapp", "createdAt": "2026-07-10T08:00:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z", "contact": { "id": "664fa1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com" }, "channel": { "id": "663fa1b2c3d4e5f6a7b8c9d0", "name": "Main WhatsApp", "type": "whatsapp" }, "assignedAgent": { "id": "662fa1b2c3d4e5f6a7b8c9d0", "fullName": "Alex Agent", "email": "alex@company.com" } }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "contactId": "664fa1b2c3d4e5f6a7b8c9d0", "channelId": "663fa1b2c3d4e5f6a7b8c9d0", "assignedAgentId": "662fa1b2c3d4e5f6a7b8c9d0", "status": "open", "priority": "medium", "isArchived": false, "labelIds": [ "661fa1b2c3d4e5f6a7b8c9d0" ], "labels": [ { "id": "661fa1b2c3d4e5f6a7b8c9d0", "name": "VIP", "color": "#6366f1" } ], "unreadCount": 2, "lastMessagePreview": "See you tomorrow!", "lastMessageAt": "2026-07-12T09:30:00.000Z", "lastMessageDirection": "inbound", "isPinned": false, "isMuted": false, "isResolved": false, "startedAt": "2026-07-10T08:00:00.000Z", "resolvedAt": null, "closedAt": null, "source": "whatsapp", "createdAt": "2026-07-10T08:00:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z", "contact": { "id": "664fa1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com" }, "channel": { "id": "663fa1b2c3d4e5f6a7b8c9d0", "name": "Main WhatsApp", "type": "whatsapp" }, "assignedAgent": { "id": "662fa1b2c3d4e5f6a7b8c9d0", "fullName": "Alex Agent", "email": "alex@company.com" } }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "403": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "404": { "description": "Conversation not found", "content": { "application/json": { "schema": { "description": "Conversation not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CONVERSATION_NOT_FOUND", "message": "Conversation not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "CONVERSATION_NOT_FOUND", "message": "Conversation not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Conversation updated", "content": { "application/json": { "schema": { "description": "Conversation updated", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "contactId": { "type": [ "null", "string" ], "example": "664fa1b2c3d4e5f6a7b8c9d0" }, "channelId": { "type": [ "null", "string" ], "example": "663fa1b2c3d4e5f6a7b8c9d0" }, "assignedAgentId": { "type": [ "null", "string" ], "example": "662fa1b2c3d4e5f6a7b8c9d0" }, "status": { "type": "string", "enum": [ "open", "pending", "resolved", "closed", "archived" ], "example": "open" }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ], "example": "medium" }, "isArchived": { "type": "boolean", "example": false }, "labelIds": { "type": "array", "items": { "type": "string" }, "example": [ "661fa1b2c3d4e5f6a7b8c9d0" ] }, "labels": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "color": { "type": [ "null", "string" ] } } } }, "unreadCount": { "type": "integer", "example": 2 }, "lastMessagePreview": { "type": [ "null", "string" ], "example": "See you tomorrow!" }, "lastMessageAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastMessageDirection": { "type": [ "null", "string" ], "example": "inbound" }, "isPinned": { "type": "boolean", "example": false }, "isMuted": { "type": "boolean", "example": false }, "isResolved": { "type": "boolean", "example": false }, "startedAt": { "type": [ "null", "string" ], "format": "date-time" }, "resolvedAt": { "type": [ "null", "string" ], "format": "date-time" }, "closedAt": { "type": [ "null", "string" ], "format": "date-time" }, "source": { "type": [ "null", "string" ], "example": "whatsapp" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "contact": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] } } }, "channel": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] } } }, "assignedAgent": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": [ "null", "string" ] }, "fullName": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] } } } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ], "example": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11" }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "contactId": "664fa1b2c3d4e5f6a7b8c9d0", "channelId": "663fa1b2c3d4e5f6a7b8c9d0", "assignedAgentId": "662fa1b2c3d4e5f6a7b8c9d0", "status": "open", "priority": "medium", "isArchived": false, "labelIds": [ "661fa1b2c3d4e5f6a7b8c9d0" ], "labels": [ { "id": "661fa1b2c3d4e5f6a7b8c9d0", "name": "VIP", "color": "#6366f1" } ], "unreadCount": 2, "lastMessagePreview": "See you tomorrow!", "lastMessageAt": "2026-07-12T09:30:00.000Z", "lastMessageDirection": "inbound", "isPinned": false, "isMuted": false, "isResolved": false, "startedAt": "2026-07-10T08:00:00.000Z", "resolvedAt": null, "closedAt": null, "source": "whatsapp", "createdAt": "2026-07-10T08:00:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z", "contact": { "id": "664fa1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com" }, "channel": { "id": "663fa1b2c3d4e5f6a7b8c9d0", "name": "Main WhatsApp", "type": "whatsapp" }, "assignedAgent": { "id": "662fa1b2c3d4e5f6a7b8c9d0", "fullName": "Alex Agent", "email": "alex@company.com" } }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "contactId": "664fa1b2c3d4e5f6a7b8c9d0", "channelId": "663fa1b2c3d4e5f6a7b8c9d0", "assignedAgentId": "662fa1b2c3d4e5f6a7b8c9d0", "status": "open", "priority": "medium", "isArchived": false, "labelIds": [ "661fa1b2c3d4e5f6a7b8c9d0" ], "labels": [ { "id": "661fa1b2c3d4e5f6a7b8c9d0", "name": "VIP", "color": "#6366f1" } ], "unreadCount": 2, "lastMessagePreview": "See you tomorrow!", "lastMessageAt": "2026-07-12T09:30:00.000Z", "lastMessageDirection": "inbound", "isPinned": false, "isMuted": false, "isResolved": false, "startedAt": "2026-07-10T08:00:00.000Z", "resolvedAt": null, "closedAt": null, "source": "whatsapp", "createdAt": "2026-07-10T08:00:00.000Z", "updatedAt": "2026-07-12T09:30:00.000Z", "contact": { "id": "664fa1b2c3d4e5f6a7b8c9d0", "name": "Jane Doe", "phone": "+14155552671", "email": "jane@example.com" }, "channel": { "id": "663fa1b2c3d4e5f6a7b8c9d0", "name": "Main WhatsApp", "type": "whatsapp" }, "assignedAgent": { "id": "662fa1b2c3d4e5f6a7b8c9d0", "fullName": "Alex Agent", "email": "alex@company.com" } }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "403": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "404": { "description": "Conversation not found", "content": { "application/json": { "schema": { "description": "Conversation not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CONVERSATION_NOT_FOUND", "message": "Conversation not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "CONVERSATION_NOT_FOUND", "message": "Conversation not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "409": { "description": "Invalid status transition or conflicting update", "content": { "application/json": { "schema": { "description": "Invalid status transition or conflicting update", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INVALID_STATUS_TRANSITION", "message": "Cannot transition conversation from closed to pending.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "INVALID_STATUS_TRANSITION", "message": "Cannot transition conversation from closed to pending.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "status" ], "message": "Invalid enum value." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "status" ], "message": "Invalid enum value." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0", "method": "PATCH" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X PATCH \"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"status\":\"resolved\",\"priority\":\"high\",\"assignedAgentId\":\"662fa1b2c3d4e5f6a7b8c9d0\"}'" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"PATCH\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"status\": \"resolved\",\n \"priority\": \"high\",\n \"assignedAgentId\": \"662fa1b2c3d4e5f6a7b8c9d0\"\n })\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"PATCH\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n },\n body: JSON.stringify({\n \"status\": \"resolved\",\n \"priority\": \"high\",\n \"assignedAgentId\": \"662fa1b2c3d4e5f6a7b8c9d0\"\n })\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\npayload = {\n \"status\": \"resolved\",\n \"priority\": \"high\",\n \"assignedAgentId\": \"662fa1b2c3d4e5f6a7b8c9d0\"\n}\nres = requests.patch(\"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers, json=payload)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .header(\"Content-Type\", \"application/json\")\n .method(\"PATCH\", HttpRequest.BodyPublishers.ofString(\"{\\\"status\\\":\\\"resolved\\\",\\\"priority\\\":\\\"high\\\",\\\"assignedAgentId\\\":\\\"662fa1b2c3d4e5f6a7b8c9d0\\\"}\"))\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Paginated list of messages", "content": { "application/json": { "schema": { "description": "Paginated list of messages", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "conversationId": { "type": [ "null", "string" ], "example": "664fa1b2c3d4e5f6a7b8c9d0" }, "contactId": { "type": [ "null", "string" ], "example": "663fa1b2c3d4e5f6a7b8c9d0" }, "channelId": { "type": [ "null", "string" ], "example": "662fa1b2c3d4e5f6a7b8c9d0" }, "direction": { "type": [ "null", "string" ], "enum": [ "inbound", "outbound", null ], "example": "outbound" }, "type": { "type": [ "null", "string" ], "example": "TEXT" }, "body": { "type": [ "null", "string" ], "example": "Hello from the Public API!" }, "status": { "type": "string", "enum": [ "queued", "sent", "delivered", "read", "failed" ], "example": "queued" }, "failureReason": { "type": [ "null", "string" ], "example": null }, "timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "replyContext": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "messageId": { "type": [ "null", "string" ] }, "preview": { "type": [ "null", "string" ] }, "from": { "type": [ "null", "string" ] } } }, "media": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "type": { "type": [ "null", "string" ] }, "mimeType": { "type": [ "null", "string" ] }, "filename": { "type": [ "null", "string" ] }, "caption": { "type": [ "null", "string" ] }, "size": { "type": [ "null", "number" ] }, "downloadStatus": { "type": [ "null", "string" ], "description": "ready (file stored, use downloadUrl), pending (inbound file still downloading), failed, or unavailable (e.g. sent by URL).", "example": "ready" }, "downloadUrl": { "type": [ "null", "string" ], "description": "Public API path to download the file (same auth headers). Null until the file is stored.", "example": "/api/public/v1/messages/6650a1b2c3d4e5f6a7b8c9d0/media" } } }, "reply": { "type": [ "null", "object" ], "additionalProperties": true, "description": "Inbound only: the option a customer picked on an interactive button or list message.", "properties": { "type": { "type": [ "null", "string" ], "enum": [ "button_reply", "list_reply", null ], "example": "button_reply" }, "id": { "type": [ "null", "string" ], "description": "The id you set on the button / row.", "example": "confirm_order" }, "title": { "type": [ "null", "string" ], "example": "Confirm" }, "description": { "type": [ "null", "string" ], "example": null } } }, "reaction": { "type": [ "null", "object" ], "additionalProperties": true }, "template": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "name": { "type": [ "null", "string" ] }, "language": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "parameters": {} } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } }, "pagination": { "type": "object", "additionalProperties": true, "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 87 }, "totalPages": { "type": "integer", "example": 4 }, "hasNextPage": { "type": "boolean", "example": true }, "hasPrevPage": { "type": "boolean", "example": false }, "nextCursor": { "type": [ "null", "string" ], "example": null }, "prevCursor": { "type": [ "null", "string" ], "example": null } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": [ { "id": "6650a1b2c3d4e5f6a7b8c9d0", "conversationId": "664fa1b2c3d4e5f6a7b8c9d0", "contactId": "663fa1b2c3d4e5f6a7b8c9d0", "channelId": "662fa1b2c3d4e5f6a7b8c9d0", "direction": "outbound", "type": "TEXT", "body": "Hello from the Public API!", "status": "delivered", "failureReason": null, "timestamp": "2026-07-12T09:30:00.000Z", "replyContext": null, "media": null, "reaction": null, "template": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:31:00.000Z" } ], "pagination": { "page": 1, "limit": 25, "total": 87, "totalPages": 4, "hasNextPage": true, "hasPrevPage": false, "nextCursor": null, "prevCursor": null }, "meta": { "apiVersion": "v1", "sort": { "field": "timestamp", "order": "desc" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": [ { "id": "6650a1b2c3d4e5f6a7b8c9d0", "conversationId": "664fa1b2c3d4e5f6a7b8c9d0", "contactId": "663fa1b2c3d4e5f6a7b8c9d0", "channelId": "662fa1b2c3d4e5f6a7b8c9d0", "direction": "outbound", "type": "TEXT", "body": "Hello from the Public API!", "status": "delivered", "failureReason": null, "timestamp": "2026-07-12T09:30:00.000Z", "replyContext": null, "media": null, "reaction": null, "template": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:31:00.000Z" } ], "pagination": { "page": 1, "limit": 25, "total": 87, "totalPages": 4, "hasNextPage": true, "hasPrevPage": false, "nextCursor": null, "prevCursor": null }, "meta": { "apiVersion": "v1", "sort": { "field": "timestamp", "order": "desc" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "422": { "description": "Validation failed (invalid body, unapproved template, missing variables, unsupported type)", "content": { "application/json": { "schema": { "description": "Validation failed (invalid body, unapproved template, missing variables, unsupported type)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "text" ], "message": "text is required" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "text" ], "message": "text is required" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/messages\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/messages\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/messages\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/messages\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/messages\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "202": { "description": "Message accepted and queued", "content": { "application/json": { "schema": { "description": "Message accepted and queued", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": [ "null", "string" ], "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "status": { "type": "string", "example": "queued" }, "conversationId": { "type": [ "null", "string" ], "example": "664fa1b2c3d4e5f6a7b8c9d0" }, "type": { "type": "string", "example": "text" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "status": "queued", "conversationId": "664fa1b2c3d4e5f6a7b8c9d0", "type": "text" }, "meta": { "apiVersion": "v1", "queued": true }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "status": "queued", "conversationId": "664fa1b2c3d4e5f6a7b8c9d0", "type": "text" }, "meta": { "apiVersion": "v1", "queued": true }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "404": { "description": "Message, conversation, contact, or template not found", "content": { "application/json": { "schema": { "description": "Message, conversation, contact, or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "MESSAGE_NOT_FOUND", "message": "Message not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "MESSAGE_NOT_FOUND", "message": "Message not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "409": { "description": "Conflicting state (e.g. conversation not sendable)", "content": { "application/json": { "schema": { "description": "Conflicting state (e.g. conversation not sendable)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CONVERSATION_NOT_SENDABLE", "message": "Conversation is not in a sendable state.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "CONVERSATION_NOT_SENDABLE", "message": "Conversation is not in a sendable state.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "422": { "description": "Validation failed (invalid body, unapproved template, missing variables, unsupported type)", "content": { "application/json": { "schema": { "description": "Validation failed (invalid body, unapproved template, missing variables, unsupported type)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "text" ], "message": "text is required" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "text" ], "message": "text is required" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X POST \"https://api.inaiy.com/api/public/v1/messages\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/messages\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/messages\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.post(\"https://api.inaiy.com/api/public/v1/messages\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/messages\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"POST\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "The message", "content": { "application/json": { "schema": { "description": "The message", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "conversationId": { "type": [ "null", "string" ], "example": "664fa1b2c3d4e5f6a7b8c9d0" }, "contactId": { "type": [ "null", "string" ], "example": "663fa1b2c3d4e5f6a7b8c9d0" }, "channelId": { "type": [ "null", "string" ], "example": "662fa1b2c3d4e5f6a7b8c9d0" }, "direction": { "type": [ "null", "string" ], "enum": [ "inbound", "outbound", null ], "example": "outbound" }, "type": { "type": [ "null", "string" ], "example": "TEXT" }, "body": { "type": [ "null", "string" ], "example": "Hello from the Public API!" }, "status": { "type": "string", "enum": [ "queued", "sent", "delivered", "read", "failed" ], "example": "queued" }, "failureReason": { "type": [ "null", "string" ], "example": null }, "timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "replyContext": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "messageId": { "type": [ "null", "string" ] }, "preview": { "type": [ "null", "string" ] }, "from": { "type": [ "null", "string" ] } } }, "media": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "type": { "type": [ "null", "string" ] }, "mimeType": { "type": [ "null", "string" ] }, "filename": { "type": [ "null", "string" ] }, "caption": { "type": [ "null", "string" ] }, "size": { "type": [ "null", "number" ] }, "downloadStatus": { "type": [ "null", "string" ], "description": "ready (file stored, use downloadUrl), pending (inbound file still downloading), failed, or unavailable (e.g. sent by URL).", "example": "ready" }, "downloadUrl": { "type": [ "null", "string" ], "description": "Public API path to download the file (same auth headers). Null until the file is stored.", "example": "/api/public/v1/messages/6650a1b2c3d4e5f6a7b8c9d0/media" } } }, "reply": { "type": [ "null", "object" ], "additionalProperties": true, "description": "Inbound only: the option a customer picked on an interactive button or list message.", "properties": { "type": { "type": [ "null", "string" ], "enum": [ "button_reply", "list_reply", null ], "example": "button_reply" }, "id": { "type": [ "null", "string" ], "description": "The id you set on the button / row.", "example": "confirm_order" }, "title": { "type": [ "null", "string" ], "example": "Confirm" }, "description": { "type": [ "null", "string" ], "example": null } } }, "reaction": { "type": [ "null", "object" ], "additionalProperties": true }, "template": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "name": { "type": [ "null", "string" ] }, "language": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "parameters": {} } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ], "example": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11" }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "conversationId": "664fa1b2c3d4e5f6a7b8c9d0", "contactId": "663fa1b2c3d4e5f6a7b8c9d0", "channelId": "662fa1b2c3d4e5f6a7b8c9d0", "direction": "outbound", "type": "TEXT", "body": "Hello from the Public API!", "status": "delivered", "failureReason": null, "timestamp": "2026-07-12T09:30:00.000Z", "replyContext": null, "media": null, "reaction": null, "template": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:31:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "conversationId": "664fa1b2c3d4e5f6a7b8c9d0", "contactId": "663fa1b2c3d4e5f6a7b8c9d0", "channelId": "662fa1b2c3d4e5f6a7b8c9d0", "direction": "outbound", "type": "TEXT", "body": "Hello from the Public API!", "status": "delivered", "failureReason": null, "timestamp": "2026-07-12T09:30:00.000Z", "replyContext": null, "media": null, "reaction": null, "template": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:31:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "404": { "description": "Message, conversation, contact, or template not found", "content": { "application/json": { "schema": { "description": "Message, conversation, contact, or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "MESSAGE_NOT_FOUND", "message": "Message not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "MESSAGE_NOT_FOUND", "message": "Message not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/messages/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/messages/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/messages/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/messages/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/messages/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Binary file stream with Content-Type set to the media MIME type.", "content": { "application/json": { "schema": { "description": "Binary file stream with Content-Type set to the media MIME type.", "type": "string", "format": "binary" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "404": { "description": "Message, conversation, contact, or template not found", "content": { "application/json": { "schema": { "description": "Message, conversation, contact, or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "MESSAGE_NOT_FOUND", "message": "Message not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "MESSAGE_NOT_FOUND", "message": "Message not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "409": { "description": "Conflicting state (e.g. conversation not sendable)", "content": { "application/json": { "schema": { "description": "Conflicting state (e.g. conversation not sendable)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CONVERSATION_NOT_SENDABLE", "message": "Conversation is not in a sendable state.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "CONVERSATION_NOT_SENDABLE", "message": "Conversation is not in a sendable state.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/messages/6650a1b2c3d4e5f6a7b8c9d0/media\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/messages/6650a1b2c3d4e5f6a7b8c9d0/media\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/messages/6650a1b2c3d4e5f6a7b8c9d0/media\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/messages/6650a1b2c3d4e5f6a7b8c9d0/media\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/messages/6650a1b2c3d4e5f6a7b8c9d0/media\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Paginated list of messages", "content": { "application/json": { "schema": { "description": "Paginated list of messages", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "conversationId": { "type": [ "null", "string" ], "example": "664fa1b2c3d4e5f6a7b8c9d0" }, "contactId": { "type": [ "null", "string" ], "example": "663fa1b2c3d4e5f6a7b8c9d0" }, "channelId": { "type": [ "null", "string" ], "example": "662fa1b2c3d4e5f6a7b8c9d0" }, "direction": { "type": [ "null", "string" ], "enum": [ "inbound", "outbound", null ], "example": "outbound" }, "type": { "type": [ "null", "string" ], "example": "TEXT" }, "body": { "type": [ "null", "string" ], "example": "Hello from the Public API!" }, "status": { "type": "string", "enum": [ "queued", "sent", "delivered", "read", "failed" ], "example": "queued" }, "failureReason": { "type": [ "null", "string" ], "example": null }, "timestamp": { "type": [ "null", "string" ], "format": "date-time" }, "replyContext": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "messageId": { "type": [ "null", "string" ] }, "preview": { "type": [ "null", "string" ] }, "from": { "type": [ "null", "string" ] } } }, "media": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "type": { "type": [ "null", "string" ] }, "mimeType": { "type": [ "null", "string" ] }, "filename": { "type": [ "null", "string" ] }, "caption": { "type": [ "null", "string" ] }, "size": { "type": [ "null", "number" ] }, "downloadStatus": { "type": [ "null", "string" ], "description": "ready (file stored, use downloadUrl), pending (inbound file still downloading), failed, or unavailable (e.g. sent by URL).", "example": "ready" }, "downloadUrl": { "type": [ "null", "string" ], "description": "Public API path to download the file (same auth headers). Null until the file is stored.", "example": "/api/public/v1/messages/6650a1b2c3d4e5f6a7b8c9d0/media" } } }, "reply": { "type": [ "null", "object" ], "additionalProperties": true, "description": "Inbound only: the option a customer picked on an interactive button or list message.", "properties": { "type": { "type": [ "null", "string" ], "enum": [ "button_reply", "list_reply", null ], "example": "button_reply" }, "id": { "type": [ "null", "string" ], "description": "The id you set on the button / row.", "example": "confirm_order" }, "title": { "type": [ "null", "string" ], "example": "Confirm" }, "description": { "type": [ "null", "string" ], "example": null } } }, "reaction": { "type": [ "null", "object" ], "additionalProperties": true }, "template": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "name": { "type": [ "null", "string" ] }, "language": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "parameters": {} } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } }, "pagination": { "type": "object", "additionalProperties": true, "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 87 }, "totalPages": { "type": "integer", "example": 4 }, "hasNextPage": { "type": "boolean", "example": true }, "hasPrevPage": { "type": "boolean", "example": false }, "nextCursor": { "type": [ "null", "string" ], "example": null }, "prevCursor": { "type": [ "null", "string" ], "example": null } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": [ { "id": "6650a1b2c3d4e5f6a7b8c9d0", "conversationId": "664fa1b2c3d4e5f6a7b8c9d0", "contactId": "663fa1b2c3d4e5f6a7b8c9d0", "channelId": "662fa1b2c3d4e5f6a7b8c9d0", "direction": "outbound", "type": "TEXT", "body": "Hello from the Public API!", "status": "delivered", "failureReason": null, "timestamp": "2026-07-12T09:30:00.000Z", "replyContext": null, "media": null, "reaction": null, "template": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:31:00.000Z" } ], "pagination": { "page": 1, "limit": 25, "total": 87, "totalPages": 4, "hasNextPage": true, "hasPrevPage": false, "nextCursor": null, "prevCursor": null }, "meta": { "apiVersion": "v1", "sort": { "field": "timestamp", "order": "desc" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": [ { "id": "6650a1b2c3d4e5f6a7b8c9d0", "conversationId": "664fa1b2c3d4e5f6a7b8c9d0", "contactId": "663fa1b2c3d4e5f6a7b8c9d0", "channelId": "662fa1b2c3d4e5f6a7b8c9d0", "direction": "outbound", "type": "TEXT", "body": "Hello from the Public API!", "status": "delivered", "failureReason": null, "timestamp": "2026-07-12T09:30:00.000Z", "replyContext": null, "media": null, "reaction": null, "template": null, "createdAt": "2026-07-12T09:30:00.000Z", "updatedAt": "2026-07-12T09:31:00.000Z" } ], "pagination": { "page": 1, "limit": 25, "total": 87, "totalPages": 4, "hasNextPage": true, "hasPrevPage": false, "nextCursor": null, "prevCursor": null }, "meta": { "apiVersion": "v1", "sort": { "field": "timestamp", "order": "desc" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "404": { "description": "Message, conversation, contact, or template not found", "content": { "application/json": { "schema": { "description": "Message, conversation, contact, or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "MESSAGE_NOT_FOUND", "message": "Message not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "MESSAGE_NOT_FOUND", "message": "Message not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/messages", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0/messages\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0/messages\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0/messages\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0/messages\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/conversations/6650a1b2c3d4e5f6a7b8c9d0/messages\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "01HXYZ..." }, "storageKey": { "type": "string", "description": "Use this as parameters.header.storageKey (templates) or media.storageKey (media messages).", "example": "tenants/.../pending/.../file.pdf" }, "mimeType": { "type": "string", "example": "application/pdf" }, "filename": { "type": "string", "example": "invoice.pdf" }, "size": { "type": "integer", "example": 245760 }, "messageType": { "type": "string", "enum": [ "IMAGE", "VIDEO", "AUDIO", "DOCUMENT" ], "example": "DOCUMENT" }, "previewUrl": { "type": "string", "example": "/api/public/v1/media/pending/01HXYZ/download?inline=1" }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X POST \"https://api.inaiy.com/api/public/v1/media/upload\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/media/upload\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/media/upload\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.post(\"https://api.inaiy.com/api/public/v1/media/upload\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/media/upload\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"POST\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "01HXYZ..." }, "storageKey": { "type": "string", "description": "Use this as parameters.header.storageKey (templates) or media.storageKey (media messages).", "example": "tenants/.../pending/.../file.pdf" }, "mimeType": { "type": "string", "example": "application/pdf" }, "filename": { "type": "string", "example": "invoice.pdf" }, "size": { "type": "integer", "example": 245760 }, "messageType": { "type": "string", "enum": [ "IMAGE", "VIDEO", "AUDIO", "DOCUMENT" ], "example": "DOCUMENT" }, "previewUrl": { "type": "string", "example": "/api/public/v1/media/pending/01HXYZ/download?inline=1" }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/media/pending/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/media/pending/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/media/pending/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/media/pending/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/media/pending/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Binary file stream", "content": { "application/json": { "schema": { "description": "Binary file stream", "type": "string", "format": "binary" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/media/pending/6650a1b2c3d4e5f6a7b8c9d0/download\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/media/pending/6650a1b2c3d4e5f6a7b8c9d0/download\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/media/pending/6650a1b2c3d4e5f6a7b8c9d0/download\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/media/pending/6650a1b2c3d4e5f6a7b8c9d0/download\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/media/pending/6650a1b2c3d4e5f6a7b8c9d0/download\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Paginated list of templates", "content": { "application/json": { "schema": { "description": "Paginated list of templates", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "name": { "type": "string", "example": "order_update" }, "category": { "type": [ "null", "string" ], "enum": [ "MARKETING", "UTILITY", "AUTHENTICATION", null ], "example": "UTILITY" }, "language": { "type": [ "null", "string" ], "example": "en_US" }, "status": { "type": [ "null", "string" ], "enum": [ "APPROVED", "PENDING", "REJECTED", "PAUSED", "DISABLED", "IN_APPEAL", "DELETED", null ], "example": "APPROVED" }, "templateType": { "type": [ "null", "string" ], "example": "STANDARD" }, "parameterFormat": { "type": [ "null", "string" ], "example": "POSITIONAL" }, "headerType": { "type": [ "null", "string" ], "example": "TEXT" }, "hasButtons": { "type": "boolean", "example": true }, "components": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "header": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "format": { "type": [ "null", "string" ], "example": "TEXT" }, "text": { "type": [ "null", "string" ], "example": "Order {{1}} update" }, "filename": { "type": [ "null", "string" ], "example": null }, "mimeType": { "type": [ "null", "string" ], "example": null } } }, "body": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "text": { "type": [ "null", "string" ], "example": "Hi {{1}}, your order is {{2}}." } } }, "footer": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "text": { "type": [ "null", "string" ], "example": "Reply STOP to unsubscribe" } } }, "buttons": { "type": [ "null", "array" ], "items": { "type": "object", "additionalProperties": true, "properties": { "type": { "type": [ "null", "string" ], "example": "URL" }, "text": { "type": [ "null", "string" ], "example": "Track order" }, "url": { "type": [ "null", "string" ], "example": "https://example.com/track/{{1}}" }, "phoneNumber": { "type": [ "null", "string" ], "example": null } } } }, "carousel": { "type": [ "null", "object" ], "additionalProperties": true } } }, "examples": { "type": [ "null", "object", "array" ] }, "variables": { "type": [ "null", "object" ], "additionalProperties": true }, "qualityScore": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "score": { "type": [ "null", "string", "number" ], "example": "GREEN" }, "date": { "type": [ "null", "string" ], "format": "date-time" } } }, "rejectionReason": { "type": [ "null", "string" ], "example": null }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time" } } } }, "pagination": { "type": "object", "additionalProperties": true, "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 42 }, "totalPages": { "type": "integer", "example": 2 }, "hasNextPage": { "type": "boolean", "example": true }, "hasPrevPage": { "type": "boolean", "example": false }, "nextCursor": { "type": [ "null", "string" ], "example": null }, "prevCursor": { "type": [ "null", "string" ], "example": null } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": [ { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "order_update", "category": "UTILITY", "language": "en_US", "status": "APPROVED", "templateType": "STANDARD", "parameterFormat": "POSITIONAL", "headerType": "TEXT", "hasButtons": true, "components": { "header": { "format": "TEXT", "text": "Order {{1}} update", "filename": null, "mimeType": null }, "body": { "text": "Hi {{1}}, your order is {{2}}." }, "footer": { "text": "Reply STOP to unsubscribe" }, "buttons": [ { "type": "URL", "text": "Track order", "url": "https://example.com/track/{{1}}", "phoneNumber": null } ], "carousel": null }, "examples": null, "variables": { "parameterFormat": "POSITIONAL", "body": [ "1", "2" ], "header": { "type": "text", "keys": [ "1" ] }, "buttons": [ { "index": 0, "type": "URL", "keys": [ "1" ] } ] }, "qualityScore": { "score": "GREEN", "date": "2026-07-10T09:30:00.000Z" }, "rejectionReason": null, "createdAt": "2026-07-01T09:30:00.000Z", "updatedAt": "2026-07-10T09:31:00.000Z" } ], "pagination": { "page": 1, "limit": 25, "total": 42, "totalPages": 2, "hasNextPage": true, "hasPrevPage": false, "nextCursor": null, "prevCursor": null }, "meta": { "apiVersion": "v1", "sort": { "field": "createdAt", "order": "desc" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": [ { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "order_update", "category": "UTILITY", "language": "en_US", "status": "APPROVED", "templateType": "STANDARD", "parameterFormat": "POSITIONAL", "headerType": "TEXT", "hasButtons": true, "components": { "header": { "format": "TEXT", "text": "Order {{1}} update", "filename": null, "mimeType": null }, "body": { "text": "Hi {{1}}, your order is {{2}}." }, "footer": { "text": "Reply STOP to unsubscribe" }, "buttons": [ { "type": "URL", "text": "Track order", "url": "https://example.com/track/{{1}}", "phoneNumber": null } ], "carousel": null }, "examples": null, "variables": { "parameterFormat": "POSITIONAL", "body": [ "1", "2" ], "header": { "type": "text", "keys": [ "1" ] }, "buttons": [ { "index": 0, "type": "URL", "keys": [ "1" ] } ] }, "qualityScore": { "score": "GREEN", "date": "2026-07-10T09:30:00.000Z" }, "rejectionReason": null, "createdAt": "2026-07-01T09:30:00.000Z", "updatedAt": "2026-07-10T09:31:00.000Z" } ], "pagination": { "page": 1, "limit": 25, "total": 42, "totalPages": 2, "hasNextPage": true, "hasPrevPage": false, "nextCursor": null, "prevCursor": null }, "meta": { "apiVersion": "v1", "sort": { "field": "createdAt", "order": "desc" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } } } }, "422": { "description": "Validation failed (invalid filters, sort, status, language, or date range)", "content": { "application/json": { "schema": { "description": "Validation failed (invalid filters, sort, status, language, or date range)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "status" ], "message": "Invalid enum value" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "status" ], "message": "Invalid enum value" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/templates\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/templates\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/templates\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/templates\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/templates\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "A single template (id lookup) or a list of templates (name lookup)", "content": { "application/json": { "schema": { "description": "A single template (id lookup) or a list of templates (name lookup)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "name": { "type": "string", "example": "order_update" }, "category": { "type": [ "null", "string" ], "enum": [ "MARKETING", "UTILITY", "AUTHENTICATION", null ], "example": "UTILITY" }, "language": { "type": [ "null", "string" ], "example": "en_US" }, "status": { "type": [ "null", "string" ], "enum": [ "APPROVED", "PENDING", "REJECTED", "PAUSED", "DISABLED", "IN_APPEAL", "DELETED", null ], "example": "APPROVED" }, "templateType": { "type": [ "null", "string" ], "example": "STANDARD" }, "parameterFormat": { "type": [ "null", "string" ], "example": "POSITIONAL" }, "headerType": { "type": [ "null", "string" ], "example": "TEXT" }, "hasButtons": { "type": "boolean", "example": true }, "components": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "header": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "format": { "type": [ "null", "string" ], "example": "TEXT" }, "text": { "type": [ "null", "string" ], "example": "Order {{1}} update" }, "filename": { "type": [ "null", "string" ], "example": null }, "mimeType": { "type": [ "null", "string" ], "example": null } } }, "body": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "text": { "type": [ "null", "string" ], "example": "Hi {{1}}, your order is {{2}}." } } }, "footer": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "text": { "type": [ "null", "string" ], "example": "Reply STOP to unsubscribe" } } }, "buttons": { "type": [ "null", "array" ], "items": { "type": "object", "additionalProperties": true, "properties": { "type": { "type": [ "null", "string" ], "example": "URL" }, "text": { "type": [ "null", "string" ], "example": "Track order" }, "url": { "type": [ "null", "string" ], "example": "https://example.com/track/{{1}}" }, "phoneNumber": { "type": [ "null", "string" ], "example": null } } } }, "carousel": { "type": [ "null", "object" ], "additionalProperties": true } } }, "examples": { "type": [ "null", "object", "array" ] }, "variables": { "type": [ "null", "object" ], "additionalProperties": true }, "qualityScore": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "score": { "type": [ "null", "string", "number" ], "example": "GREEN" }, "date": { "type": [ "null", "string" ], "format": "date-time" } } }, "rejectionReason": { "type": [ "null", "string" ], "example": null }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ], "example": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11" }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "order_update", "category": "UTILITY", "language": "en_US", "status": "APPROVED", "templateType": "STANDARD", "parameterFormat": "POSITIONAL", "headerType": "TEXT", "hasButtons": true, "components": { "header": { "format": "TEXT", "text": "Order {{1}} update", "filename": null, "mimeType": null }, "body": { "text": "Hi {{1}}, your order is {{2}}." }, "footer": { "text": "Reply STOP to unsubscribe" }, "buttons": [ { "type": "URL", "text": "Track order", "url": "https://example.com/track/{{1}}", "phoneNumber": null } ], "carousel": null }, "examples": null, "variables": { "parameterFormat": "POSITIONAL", "body": [ "1", "2" ], "header": { "type": "text", "keys": [ "1" ] }, "buttons": [ { "index": 0, "type": "URL", "keys": [ "1" ] } ] }, "qualityScore": { "score": "GREEN", "date": "2026-07-10T09:30:00.000Z" }, "rejectionReason": null, "createdAt": "2026-07-01T09:30:00.000Z", "updatedAt": "2026-07-10T09:31:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "order_update", "category": "UTILITY", "language": "en_US", "status": "APPROVED", "templateType": "STANDARD", "parameterFormat": "POSITIONAL", "headerType": "TEXT", "hasButtons": true, "components": { "header": { "format": "TEXT", "text": "Order {{1}} update", "filename": null, "mimeType": null }, "body": { "text": "Hi {{1}}, your order is {{2}}." }, "footer": { "text": "Reply STOP to unsubscribe" }, "buttons": [ { "type": "URL", "text": "Track order", "url": "https://example.com/track/{{1}}", "phoneNumber": null } ], "carousel": null }, "examples": null, "variables": { "parameterFormat": "POSITIONAL", "body": [ "1", "2" ], "header": { "type": "text", "keys": [ "1" ] }, "buttons": [ { "index": 0, "type": "URL", "keys": [ "1" ] } ] }, "qualityScore": { "score": "GREEN", "date": "2026-07-10T09:30:00.000Z" }, "rejectionReason": null, "createdAt": "2026-07-01T09:30:00.000Z", "updatedAt": "2026-07-10T09:31:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } } } }, "404": { "description": "Template not found", "content": { "application/json": { "schema": { "description": "Template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "TEMPLATE_NOT_FOUND", "message": "Template not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } }, "example": { "success": false, "error": { "code": "TEMPLATE_NOT_FOUND", "message": "Template not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } } } }, "422": { "description": "Validation failed (invalid filters, sort, status, language, or date range)", "content": { "application/json": { "schema": { "description": "Validation failed (invalid filters, sort, status, language, or date range)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "status" ], "message": "Invalid enum value" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "status" ], "message": "Invalid enum value" } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:30:00.000Z", "path": "/api/public/v1/templates", "method": "GET" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/templates/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/templates/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/templates/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/templates/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/templates/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Paginated list of broadcasts", "content": { "application/json": { "schema": { "description": "Paginated list of broadcasts", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "name": { "type": "string", "example": "July promo blast" }, "description": { "type": [ "null", "string" ], "example": "Summer sale announcement" }, "status": { "type": [ "null", "string" ], "enum": [ "DRAFT", "SCHEDULED", "RUNNING", "PAUSED", "COMPLETED", "CANCELLED", "FAILED", null ], "example": "DRAFT" }, "templateId": { "type": [ "null", "string" ], "example": "6650a1b2c3d4e5f6a7b8c9d1" }, "composition": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "templateId": { "type": [ "null", "string" ] }, "parameters": { "type": [ "null", "object" ], "additionalProperties": true } } }, "audience": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "type": { "type": [ "null", "string" ], "enum": [ "MANUAL", "ALL", "SEGMENT", null ], "example": "MANUAL" }, "selection": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "contactIds": { "type": "array", "items": { "type": "string" } }, "includeTags": { "type": "array", "items": { "type": "string" } }, "excludeContactIds": { "type": "array", "items": { "type": "string" } }, "excludeTags": { "type": "array", "items": { "type": "string" } } } }, "counts": { "type": [ "null", "object" ], "additionalProperties": true }, "validation": { "type": [ "null", "object" ], "additionalProperties": true } } }, "schedule": { "type": [ "null", "object" ], "additionalProperties": true }, "stats": { "type": [ "null", "object" ], "additionalProperties": true }, "progress": { "type": [ "null", "object" ], "additionalProperties": true }, "execution": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "executionId": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "mode": { "type": [ "null", "string" ] }, "startedAt": { "type": [ "null", "string" ], "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "cancelledAt": { "type": [ "null", "string" ], "format": "date-time" }, "failureReason": { "type": [ "null", "string" ] } } }, "monitoring": { "type": [ "null", "object" ], "additionalProperties": true }, "isArchived": { "type": "boolean", "example": false }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time" } } } }, "pagination": { "type": "object", "additionalProperties": true, "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 12 }, "totalPages": { "type": "integer", "example": 1 }, "hasNextPage": { "type": "boolean", "example": false }, "hasPrevPage": { "type": "boolean", "example": false }, "nextCursor": { "type": [ "null", "string" ], "example": null }, "prevCursor": { "type": [ "null", "string" ], "example": null } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": [ { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "July promo blast", "description": "Summer sale announcement", "status": "DRAFT", "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "composition": { "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "parameters": { "body": [ "Jane" ] } }, "audience": { "type": "MANUAL", "selection": { "contactIds": [ "663fa1b2c3d4e5f6a7b8c9d0" ], "includeTags": [ "vip" ], "excludeContactIds": [], "excludeTags": [] }, "counts": { "estimated": 240, "resolved": 240, "lastEstimatedAt": "2026-07-12T09:00:00.000Z", "lastResolvedAt": "2026-07-12T09:00:00.000Z" }, "validation": { "isValid": true, "issues": [], "lastValidatedAt": "2026-07-12T09:00:00.000Z" } }, "schedule": null, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "progress": { "processed": 0, "total": 240, "percent": 0 }, "execution": null, "monitoring": null, "isArchived": false, "createdAt": "2026-07-12T09:00:00.000Z", "updatedAt": "2026-07-12T09:00:00.000Z" } ], "pagination": { "page": 1, "limit": 25, "total": 12, "totalPages": 1, "hasNextPage": false, "hasPrevPage": false, "nextCursor": null, "prevCursor": null }, "meta": { "apiVersion": "v1", "sort": { "field": "updatedAt", "order": "desc" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z" } }, "example": { "success": true, "data": [ { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "July promo blast", "description": "Summer sale announcement", "status": "DRAFT", "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "composition": { "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "parameters": { "body": [ "Jane" ] } }, "audience": { "type": "MANUAL", "selection": { "contactIds": [ "663fa1b2c3d4e5f6a7b8c9d0" ], "includeTags": [ "vip" ], "excludeContactIds": [], "excludeTags": [] }, "counts": { "estimated": 240, "resolved": 240, "lastEstimatedAt": "2026-07-12T09:00:00.000Z", "lastResolvedAt": "2026-07-12T09:00:00.000Z" }, "validation": { "isValid": true, "issues": [], "lastValidatedAt": "2026-07-12T09:00:00.000Z" } }, "schedule": null, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "progress": { "processed": 0, "total": 240, "percent": 0 }, "execution": null, "monitoring": null, "isArchived": false, "createdAt": "2026-07-12T09:00:00.000Z", "updatedAt": "2026-07-12T09:00:00.000Z" } ], "pagination": { "page": 1, "limit": 25, "total": 12, "totalPages": 1, "hasNextPage": false, "hasPrevPage": false, "nextCursor": null, "prevCursor": null }, "meta": { "apiVersion": "v1", "sort": { "field": "updatedAt", "order": "desc" } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "422": { "description": "Validation failed (invalid body, empty/segment audience, missing template, no connected channel)", "content": { "application/json": { "schema": { "description": "Validation failed (invalid body, empty/segment audience, missing template, no connected channel)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "name" ], "message": "Broadcast name is required." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "name" ], "message": "Broadcast name is required." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/broadcasts\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/broadcasts\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/broadcasts\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "201": { "description": "Draft broadcast created", "content": { "application/json": { "schema": { "description": "Draft broadcast created", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "name": { "type": "string", "example": "July promo blast" }, "description": { "type": [ "null", "string" ], "example": "Summer sale announcement" }, "status": { "type": [ "null", "string" ], "enum": [ "DRAFT", "SCHEDULED", "RUNNING", "PAUSED", "COMPLETED", "CANCELLED", "FAILED", null ], "example": "DRAFT" }, "templateId": { "type": [ "null", "string" ], "example": "6650a1b2c3d4e5f6a7b8c9d1" }, "composition": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "templateId": { "type": [ "null", "string" ] }, "parameters": { "type": [ "null", "object" ], "additionalProperties": true } } }, "audience": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "type": { "type": [ "null", "string" ], "enum": [ "MANUAL", "ALL", "SEGMENT", null ], "example": "MANUAL" }, "selection": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "contactIds": { "type": "array", "items": { "type": "string" } }, "includeTags": { "type": "array", "items": { "type": "string" } }, "excludeContactIds": { "type": "array", "items": { "type": "string" } }, "excludeTags": { "type": "array", "items": { "type": "string" } } } }, "counts": { "type": [ "null", "object" ], "additionalProperties": true }, "validation": { "type": [ "null", "object" ], "additionalProperties": true } } }, "schedule": { "type": [ "null", "object" ], "additionalProperties": true }, "stats": { "type": [ "null", "object" ], "additionalProperties": true }, "progress": { "type": [ "null", "object" ], "additionalProperties": true }, "execution": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "executionId": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "mode": { "type": [ "null", "string" ] }, "startedAt": { "type": [ "null", "string" ], "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "cancelledAt": { "type": [ "null", "string" ], "format": "date-time" }, "failureReason": { "type": [ "null", "string" ] } } }, "monitoring": { "type": [ "null", "object" ], "additionalProperties": true }, "isArchived": { "type": "boolean", "example": false }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ], "example": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11" }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "July promo blast", "description": "Summer sale announcement", "status": "DRAFT", "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "composition": { "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "parameters": { "body": [ "Jane" ] } }, "audience": { "type": "MANUAL", "selection": { "contactIds": [ "663fa1b2c3d4e5f6a7b8c9d0" ], "includeTags": [ "vip" ], "excludeContactIds": [], "excludeTags": [] }, "counts": { "estimated": 240, "resolved": 240, "lastEstimatedAt": "2026-07-12T09:00:00.000Z", "lastResolvedAt": "2026-07-12T09:00:00.000Z" }, "validation": { "isValid": true, "issues": [], "lastValidatedAt": "2026-07-12T09:00:00.000Z" } }, "schedule": null, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "progress": { "processed": 0, "total": 240, "percent": 0 }, "execution": null, "monitoring": null, "isArchived": false, "createdAt": "2026-07-12T09:00:00.000Z", "updatedAt": "2026-07-12T09:00:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "July promo blast", "description": "Summer sale announcement", "status": "DRAFT", "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "composition": { "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "parameters": { "body": [ "Jane" ] } }, "audience": { "type": "MANUAL", "selection": { "contactIds": [ "663fa1b2c3d4e5f6a7b8c9d0" ], "includeTags": [ "vip" ], "excludeContactIds": [], "excludeTags": [] }, "counts": { "estimated": 240, "resolved": 240, "lastEstimatedAt": "2026-07-12T09:00:00.000Z", "lastResolvedAt": "2026-07-12T09:00:00.000Z" }, "validation": { "isValid": true, "issues": [], "lastValidatedAt": "2026-07-12T09:00:00.000Z" } }, "schedule": null, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "progress": { "processed": 0, "total": 240, "percent": 0 }, "execution": null, "monitoring": null, "isArchived": false, "createdAt": "2026-07-12T09:00:00.000Z", "updatedAt": "2026-07-12T09:00:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z" } } } }, "202": { "description": "Broadcast queued or scheduled", "content": { "application/json": { "schema": { "description": "Broadcast queued or scheduled", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "broadcastId": { "type": [ "null", "string" ], "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "status": { "type": [ "null", "string" ], "example": "RUNNING" }, "execution": { "type": [ "null", "object" ], "additionalProperties": true }, "schedule": { "type": [ "null", "object" ], "additionalProperties": true }, "progress": { "type": [ "null", "object" ], "additionalProperties": true }, "stats": { "type": [ "null", "object" ], "additionalProperties": true }, "estimatedRecipients": { "type": "integer", "example": 240 }, "timezone": { "type": [ "null", "string" ], "example": "Asia/Kolkata" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "broadcastId": "6650a1b2c3d4e5f6a7b8c9d0", "status": "RUNNING", "execution": { "executionId": "exec_9f8e7d", "status": "queued", "mode": "immediate", "startedAt": "2026-07-12T09:05:00.000Z", "completedAt": null, "cancelledAt": null, "failureReason": null }, "schedule": null, "progress": { "processed": 0, "total": 240, "percent": 0 }, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "estimatedRecipients": 240, "timezone": "Asia/Kolkata" }, "meta": { "apiVersion": "v1", "queued": true }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:05:00.000Z" } }, "example": { "success": true, "data": { "broadcastId": "6650a1b2c3d4e5f6a7b8c9d0", "status": "RUNNING", "execution": { "executionId": "exec_9f8e7d", "status": "queued", "mode": "immediate", "startedAt": "2026-07-12T09:05:00.000Z", "completedAt": null, "cancelledAt": null, "failureReason": null }, "schedule": null, "progress": { "processed": 0, "total": 240, "percent": 0 }, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "estimatedRecipients": 240, "timezone": "Asia/Kolkata" }, "meta": { "apiVersion": "v1", "queued": true }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:05:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "404": { "description": "Broadcast or template not found", "content": { "application/json": { "schema": { "description": "Broadcast or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "409": { "description": "Conflicting state (not editable, cancel not allowed, already running)", "content": { "application/json": { "schema": { "description": "Conflicting state (not editable, cancel not allowed, already running)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_EDITABLE", "message": "Only draft broadcasts can be modified.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_EDITABLE", "message": "Only draft broadcasts can be modified.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "422": { "description": "Validation failed (invalid body, empty/segment audience, missing template, no connected channel)", "content": { "application/json": { "schema": { "description": "Validation failed (invalid body, empty/segment audience, missing template, no connected channel)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "name" ], "message": "Broadcast name is required." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "name" ], "message": "Broadcast name is required." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X POST \"https://api.inaiy.com/api/public/v1/broadcasts\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.post(\"https://api.inaiy.com/api/public/v1/broadcasts\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/broadcasts\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"POST\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "The broadcast", "content": { "application/json": { "schema": { "description": "The broadcast", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "name": { "type": "string", "example": "July promo blast" }, "description": { "type": [ "null", "string" ], "example": "Summer sale announcement" }, "status": { "type": [ "null", "string" ], "enum": [ "DRAFT", "SCHEDULED", "RUNNING", "PAUSED", "COMPLETED", "CANCELLED", "FAILED", null ], "example": "DRAFT" }, "templateId": { "type": [ "null", "string" ], "example": "6650a1b2c3d4e5f6a7b8c9d1" }, "composition": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "templateId": { "type": [ "null", "string" ] }, "parameters": { "type": [ "null", "object" ], "additionalProperties": true } } }, "audience": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "type": { "type": [ "null", "string" ], "enum": [ "MANUAL", "ALL", "SEGMENT", null ], "example": "MANUAL" }, "selection": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "contactIds": { "type": "array", "items": { "type": "string" } }, "includeTags": { "type": "array", "items": { "type": "string" } }, "excludeContactIds": { "type": "array", "items": { "type": "string" } }, "excludeTags": { "type": "array", "items": { "type": "string" } } } }, "counts": { "type": [ "null", "object" ], "additionalProperties": true }, "validation": { "type": [ "null", "object" ], "additionalProperties": true } } }, "schedule": { "type": [ "null", "object" ], "additionalProperties": true }, "stats": { "type": [ "null", "object" ], "additionalProperties": true }, "progress": { "type": [ "null", "object" ], "additionalProperties": true }, "execution": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "executionId": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "mode": { "type": [ "null", "string" ] }, "startedAt": { "type": [ "null", "string" ], "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "cancelledAt": { "type": [ "null", "string" ], "format": "date-time" }, "failureReason": { "type": [ "null", "string" ] } } }, "monitoring": { "type": [ "null", "object" ], "additionalProperties": true }, "isArchived": { "type": "boolean", "example": false }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ], "example": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11" }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "July promo blast", "description": "Summer sale announcement", "status": "DRAFT", "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "composition": { "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "parameters": { "body": [ "Jane" ] } }, "audience": { "type": "MANUAL", "selection": { "contactIds": [ "663fa1b2c3d4e5f6a7b8c9d0" ], "includeTags": [ "vip" ], "excludeContactIds": [], "excludeTags": [] }, "counts": { "estimated": 240, "resolved": 240, "lastEstimatedAt": "2026-07-12T09:00:00.000Z", "lastResolvedAt": "2026-07-12T09:00:00.000Z" }, "validation": { "isValid": true, "issues": [], "lastValidatedAt": "2026-07-12T09:00:00.000Z" } }, "schedule": null, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "progress": { "processed": 0, "total": 240, "percent": 0 }, "execution": null, "monitoring": null, "isArchived": false, "createdAt": "2026-07-12T09:00:00.000Z", "updatedAt": "2026-07-12T09:00:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "July promo blast", "description": "Summer sale announcement", "status": "DRAFT", "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "composition": { "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "parameters": { "body": [ "Jane" ] } }, "audience": { "type": "MANUAL", "selection": { "contactIds": [ "663fa1b2c3d4e5f6a7b8c9d0" ], "includeTags": [ "vip" ], "excludeContactIds": [], "excludeTags": [] }, "counts": { "estimated": 240, "resolved": 240, "lastEstimatedAt": "2026-07-12T09:00:00.000Z", "lastResolvedAt": "2026-07-12T09:00:00.000Z" }, "validation": { "isValid": true, "issues": [], "lastValidatedAt": "2026-07-12T09:00:00.000Z" } }, "schedule": null, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "progress": { "processed": 0, "total": 240, "percent": 0 }, "execution": null, "monitoring": null, "isArchived": false, "createdAt": "2026-07-12T09:00:00.000Z", "updatedAt": "2026-07-12T09:00:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "404": { "description": "Broadcast or template not found", "content": { "application/json": { "schema": { "description": "Broadcast or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "The updated broadcast", "content": { "application/json": { "schema": { "description": "The updated broadcast", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "name": { "type": "string", "example": "July promo blast" }, "description": { "type": [ "null", "string" ], "example": "Summer sale announcement" }, "status": { "type": [ "null", "string" ], "enum": [ "DRAFT", "SCHEDULED", "RUNNING", "PAUSED", "COMPLETED", "CANCELLED", "FAILED", null ], "example": "DRAFT" }, "templateId": { "type": [ "null", "string" ], "example": "6650a1b2c3d4e5f6a7b8c9d1" }, "composition": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "templateId": { "type": [ "null", "string" ] }, "parameters": { "type": [ "null", "object" ], "additionalProperties": true } } }, "audience": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "type": { "type": [ "null", "string" ], "enum": [ "MANUAL", "ALL", "SEGMENT", null ], "example": "MANUAL" }, "selection": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "contactIds": { "type": "array", "items": { "type": "string" } }, "includeTags": { "type": "array", "items": { "type": "string" } }, "excludeContactIds": { "type": "array", "items": { "type": "string" } }, "excludeTags": { "type": "array", "items": { "type": "string" } } } }, "counts": { "type": [ "null", "object" ], "additionalProperties": true }, "validation": { "type": [ "null", "object" ], "additionalProperties": true } } }, "schedule": { "type": [ "null", "object" ], "additionalProperties": true }, "stats": { "type": [ "null", "object" ], "additionalProperties": true }, "progress": { "type": [ "null", "object" ], "additionalProperties": true }, "execution": { "type": [ "null", "object" ], "additionalProperties": true, "properties": { "executionId": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "mode": { "type": [ "null", "string" ] }, "startedAt": { "type": [ "null", "string" ], "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "cancelledAt": { "type": [ "null", "string" ], "format": "date-time" }, "failureReason": { "type": [ "null", "string" ] } } }, "monitoring": { "type": [ "null", "object" ], "additionalProperties": true }, "isArchived": { "type": "boolean", "example": false }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ], "example": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11" }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "July promo blast", "description": "Summer sale announcement", "status": "DRAFT", "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "composition": { "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "parameters": { "body": [ "Jane" ] } }, "audience": { "type": "MANUAL", "selection": { "contactIds": [ "663fa1b2c3d4e5f6a7b8c9d0" ], "includeTags": [ "vip" ], "excludeContactIds": [], "excludeTags": [] }, "counts": { "estimated": 240, "resolved": 240, "lastEstimatedAt": "2026-07-12T09:00:00.000Z", "lastResolvedAt": "2026-07-12T09:00:00.000Z" }, "validation": { "isValid": true, "issues": [], "lastValidatedAt": "2026-07-12T09:00:00.000Z" } }, "schedule": null, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "progress": { "processed": 0, "total": 240, "percent": 0 }, "execution": null, "monitoring": null, "isArchived": false, "createdAt": "2026-07-12T09:00:00.000Z", "updatedAt": "2026-07-12T09:00:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z" } }, "example": { "success": true, "data": { "id": "6650a1b2c3d4e5f6a7b8c9d0", "name": "July promo blast", "description": "Summer sale announcement", "status": "DRAFT", "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "composition": { "templateId": "6650a1b2c3d4e5f6a7b8c9d1", "parameters": { "body": [ "Jane" ] } }, "audience": { "type": "MANUAL", "selection": { "contactIds": [ "663fa1b2c3d4e5f6a7b8c9d0" ], "includeTags": [ "vip" ], "excludeContactIds": [], "excludeTags": [] }, "counts": { "estimated": 240, "resolved": 240, "lastEstimatedAt": "2026-07-12T09:00:00.000Z", "lastResolvedAt": "2026-07-12T09:00:00.000Z" }, "validation": { "isValid": true, "issues": [], "lastValidatedAt": "2026-07-12T09:00:00.000Z" } }, "schedule": null, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "progress": { "processed": 0, "total": 240, "percent": 0 }, "execution": null, "monitoring": null, "isArchived": false, "createdAt": "2026-07-12T09:00:00.000Z", "updatedAt": "2026-07-12T09:00:00.000Z" }, "meta": { "apiVersion": "v1" }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "404": { "description": "Broadcast or template not found", "content": { "application/json": { "schema": { "description": "Broadcast or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "409": { "description": "Conflicting state (not editable, cancel not allowed, already running)", "content": { "application/json": { "schema": { "description": "Conflicting state (not editable, cancel not allowed, already running)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_EDITABLE", "message": "Only draft broadcasts can be modified.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_EDITABLE", "message": "Only draft broadcasts can be modified.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "422": { "description": "Validation failed (invalid body, empty/segment audience, missing template, no connected channel)", "content": { "application/json": { "schema": { "description": "Validation failed (invalid body, empty/segment audience, missing template, no connected channel)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "name" ], "message": "Broadcast name is required." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "name" ], "message": "Broadcast name is required." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X PATCH \"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"PATCH\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"PATCH\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.patch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"PATCH\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "204": { "description": "Broadcast deleted" }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "404": { "description": "Broadcast or template not found", "content": { "application/json": { "schema": { "description": "Broadcast or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "409": { "description": "Conflicting state (not editable, cancel not allowed, already running)", "content": { "application/json": { "schema": { "description": "Conflicting state (not editable, cancel not allowed, already running)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_EDITABLE", "message": "Only draft broadcasts can be modified.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_EDITABLE", "message": "Only draft broadcasts can be modified.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X DELETE \"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"DELETE\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"DELETE\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.delete(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"DELETE\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "202": { "description": "Broadcast queued for execution", "content": { "application/json": { "schema": { "description": "Broadcast queued for execution", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "broadcastId": { "type": [ "null", "string" ], "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "status": { "type": [ "null", "string" ], "example": "RUNNING" }, "execution": { "type": [ "null", "object" ], "additionalProperties": true }, "schedule": { "type": [ "null", "object" ], "additionalProperties": true }, "progress": { "type": [ "null", "object" ], "additionalProperties": true }, "stats": { "type": [ "null", "object" ], "additionalProperties": true }, "estimatedRecipients": { "type": "integer", "example": 240 }, "timezone": { "type": [ "null", "string" ], "example": "Asia/Kolkata" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "broadcastId": "6650a1b2c3d4e5f6a7b8c9d0", "status": "RUNNING", "execution": { "executionId": "exec_9f8e7d", "status": "queued", "mode": "immediate", "startedAt": "2026-07-12T09:05:00.000Z", "completedAt": null, "cancelledAt": null, "failureReason": null }, "schedule": null, "progress": { "processed": 0, "total": 240, "percent": 0 }, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "estimatedRecipients": 240, "timezone": "Asia/Kolkata" }, "meta": { "apiVersion": "v1", "queued": true }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:05:00.000Z" } }, "example": { "success": true, "data": { "broadcastId": "6650a1b2c3d4e5f6a7b8c9d0", "status": "RUNNING", "execution": { "executionId": "exec_9f8e7d", "status": "queued", "mode": "immediate", "startedAt": "2026-07-12T09:05:00.000Z", "completedAt": null, "cancelledAt": null, "failureReason": null }, "schedule": null, "progress": { "processed": 0, "total": 240, "percent": 0 }, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "estimatedRecipients": 240, "timezone": "Asia/Kolkata" }, "meta": { "apiVersion": "v1", "queued": true }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:05:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "404": { "description": "Broadcast or template not found", "content": { "application/json": { "schema": { "description": "Broadcast or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "409": { "description": "Conflicting state (not editable, cancel not allowed, already running)", "content": { "application/json": { "schema": { "description": "Conflicting state (not editable, cancel not allowed, already running)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_EDITABLE", "message": "Only draft broadcasts can be modified.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_EDITABLE", "message": "Only draft broadcasts can be modified.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "422": { "description": "Validation failed (invalid body, empty/segment audience, missing template, no connected channel)", "content": { "application/json": { "schema": { "description": "Validation failed (invalid body, empty/segment audience, missing template, no connected channel)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "name" ], "message": "Broadcast name is required." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "name" ], "message": "Broadcast name is required." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X POST \"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/execute\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/execute\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/execute\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.post(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/execute\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/execute\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"POST\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "202": { "description": "Broadcast scheduled", "content": { "application/json": { "schema": { "description": "Broadcast scheduled", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "broadcastId": { "type": [ "null", "string" ], "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "status": { "type": [ "null", "string" ], "example": "RUNNING" }, "execution": { "type": [ "null", "object" ], "additionalProperties": true }, "schedule": { "type": [ "null", "object" ], "additionalProperties": true }, "progress": { "type": [ "null", "object" ], "additionalProperties": true }, "stats": { "type": [ "null", "object" ], "additionalProperties": true }, "estimatedRecipients": { "type": "integer", "example": 240 }, "timezone": { "type": [ "null", "string" ], "example": "Asia/Kolkata" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "broadcastId": "6650a1b2c3d4e5f6a7b8c9d0", "status": "RUNNING", "execution": { "executionId": "exec_9f8e7d", "status": "queued", "mode": "immediate", "startedAt": "2026-07-12T09:05:00.000Z", "completedAt": null, "cancelledAt": null, "failureReason": null }, "schedule": null, "progress": { "processed": 0, "total": 240, "percent": 0 }, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "estimatedRecipients": 240, "timezone": "Asia/Kolkata" }, "meta": { "apiVersion": "v1", "queued": true }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:05:00.000Z" } }, "example": { "success": true, "data": { "broadcastId": "6650a1b2c3d4e5f6a7b8c9d0", "status": "RUNNING", "execution": { "executionId": "exec_9f8e7d", "status": "queued", "mode": "immediate", "startedAt": "2026-07-12T09:05:00.000Z", "completedAt": null, "cancelledAt": null, "failureReason": null }, "schedule": null, "progress": { "processed": 0, "total": 240, "percent": 0 }, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "estimatedRecipients": 240, "timezone": "Asia/Kolkata" }, "meta": { "apiVersion": "v1", "queued": true }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:05:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "404": { "description": "Broadcast or template not found", "content": { "application/json": { "schema": { "description": "Broadcast or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "409": { "description": "Conflicting state (not editable, cancel not allowed, already running)", "content": { "application/json": { "schema": { "description": "Conflicting state (not editable, cancel not allowed, already running)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_EDITABLE", "message": "Only draft broadcasts can be modified.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_EDITABLE", "message": "Only draft broadcasts can be modified.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "422": { "description": "Validation failed (invalid body, empty/segment audience, missing template, no connected channel)", "content": { "application/json": { "schema": { "description": "Validation failed (invalid body, empty/segment audience, missing template, no connected channel)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "name" ], "message": "Broadcast name is required." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "name" ], "message": "Broadcast name is required." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X POST \"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/schedule\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/schedule\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/schedule\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.post(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/schedule\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/schedule\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"POST\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Broadcast cancelled", "content": { "application/json": { "schema": { "description": "Broadcast cancelled", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "broadcastId": { "type": [ "null", "string" ], "example": "6650a1b2c3d4e5f6a7b8c9d0" }, "status": { "type": [ "null", "string" ], "example": "RUNNING" }, "execution": { "type": [ "null", "object" ], "additionalProperties": true }, "schedule": { "type": [ "null", "object" ], "additionalProperties": true }, "progress": { "type": [ "null", "object" ], "additionalProperties": true }, "stats": { "type": [ "null", "object" ], "additionalProperties": true }, "estimatedRecipients": { "type": "integer", "example": 240 }, "timezone": { "type": [ "null", "string" ], "example": "Asia/Kolkata" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } }, "example": { "success": true, "data": { "broadcastId": "6650a1b2c3d4e5f6a7b8c9d0", "status": "RUNNING", "execution": { "executionId": "exec_9f8e7d", "status": "queued", "mode": "immediate", "startedAt": "2026-07-12T09:05:00.000Z", "completedAt": null, "cancelledAt": null, "failureReason": null }, "schedule": null, "progress": { "processed": 0, "total": 240, "percent": 0 }, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "estimatedRecipients": 240, "timezone": "Asia/Kolkata" }, "meta": { "apiVersion": "v1", "queued": true }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:05:00.000Z" } }, "example": { "success": true, "data": { "broadcastId": "6650a1b2c3d4e5f6a7b8c9d0", "status": "RUNNING", "execution": { "executionId": "exec_9f8e7d", "status": "queued", "mode": "immediate", "startedAt": "2026-07-12T09:05:00.000Z", "completedAt": null, "cancelledAt": null, "failureReason": null }, "schedule": null, "progress": { "processed": 0, "total": 240, "percent": 0 }, "stats": { "total": 240, "pending": 240, "queued": 0, "processing": 0, "completed": 0, "failed": 0, "cancelled": 0, "skipped": 0 }, "estimatedRecipients": 240, "timezone": "Asia/Kolkata" }, "meta": { "apiVersion": "v1", "queued": true }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:05:00.000Z" } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "404": { "description": "Broadcast or template not found", "content": { "application/json": { "schema": { "description": "Broadcast or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "409": { "description": "Conflicting state (not editable, cancel not allowed, already running)", "content": { "application/json": { "schema": { "description": "Conflicting state (not editable, cancel not allowed, already running)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_EDITABLE", "message": "Only draft broadcasts can be modified.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_EDITABLE", "message": "Only draft broadcasts can be modified.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X POST \"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/cancel\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/cancel\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/cancel\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.post(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/cancel\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/cancel\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"POST\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Broadcast progress snapshot", "content": { "application/json": { "schema": { "description": "Broadcast progress snapshot", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "broadcastId": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "phase": { "type": [ "null", "string" ] }, "counts": { "type": "object", "additionalProperties": true }, "completionPercent": { "type": "number", "example": 42 }, "timing": { "type": [ "null", "object" ], "additionalProperties": true }, "retry": { "type": [ "null", "object" ], "additionalProperties": true }, "lastUpdatedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "404": { "description": "Broadcast or template not found", "content": { "application/json": { "schema": { "description": "Broadcast or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/progress\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/progress\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/progress\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/progress\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/progress\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Broadcast analytics", "content": { "application/json": { "schema": { "description": "Broadcast analytics", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "broadcast": { "type": "object", "additionalProperties": true }, "metrics": { "type": [ "null", "object" ], "additionalProperties": true }, "timing": { "type": [ "null", "object" ], "additionalProperties": true }, "summary": { "type": [ "null", "object" ], "additionalProperties": true }, "hasData": { "type": "boolean" }, "charts": { "type": [ "null", "object" ], "additionalProperties": true } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "404": { "description": "Broadcast or template not found", "content": { "application/json": { "schema": { "description": "Broadcast or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/analytics\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/analytics\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/analytics\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/analytics\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/analytics\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Broadcast recipients", "content": { "application/json": { "schema": { "description": "Broadcast recipients", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "example": "6650a1b2c3d4e5f6a7b8c9e1" }, "contactId": { "type": [ "null", "string" ], "example": "6650a1b2c3d4e5f6a7b8c9f2" }, "contactName": { "type": [ "null", "string" ], "example": "Asha" }, "phone": { "type": [ "null", "string" ], "example": "+919800000000" }, "status": { "type": [ "null", "string" ], "description": "Send pipeline state.", "example": "sent" }, "deliveryStatus": { "type": [ "null", "string" ], "description": "WhatsApp delivery outcome.", "example": "read" }, "messageId": { "type": [ "null", "string" ], "description": "Message id, usable with GET /messages/{id}." }, "failureReason": { "type": [ "null", "string" ], "example": null }, "retryCount": { "type": "integer", "example": 0 }, "queuedAt": { "type": [ "null", "string" ], "format": "date-time" }, "sentAt": { "type": [ "null", "string" ], "format": "date-time" }, "deliveredAt": { "type": [ "null", "string" ], "format": "date-time" }, "readAt": { "type": [ "null", "string" ], "format": "date-time" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time" } } } }, "pagination": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "ACCOUNT_CONFIGURATION_ERROR", "message": "Tenant and product context is required. Provide the x-tenant-id header.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "description": "Missing or invalid API key", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "API_KEY_INVALID", "message": "Invalid API key.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "403": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden - developer platform disabled, key expired/disabled, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "DEVELOPER_PLATFORM_DISABLED", "message": "Developer platform is disabled for this organization.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "404": { "description": "Broadcast or template not found", "content": { "application/json": { "schema": { "description": "Broadcast or template not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "CAMPAIGN_NOT_FOUND", "message": "Campaign not found.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "422": { "description": "Validation failed (invalid body, empty/segment audience, missing template, no connected channel)", "content": { "application/json": { "schema": { "description": "Validation failed (invalid body, empty/segment audience, missing template, no connected channel)", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "name" ], "message": "Broadcast name is required." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Validation failed", "details": { "issues": [ { "path": [ "name" ], "message": "Broadcast name is required." } ] } }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "429": { "description": "Too many requests - rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests - rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please retry later.", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } }, "example": { "success": false, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "details": {} }, "requestId": "a1f4c2e0-9b6d-4a1e-8c3f-2d7e5b9a0c11", "timestamp": "2026-07-12T09:00:00.000Z", "path": "/api/public/v1/broadcasts", "method": "POST" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/recipients\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/recipients\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/recipients\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/recipients\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/broadcasts/6650a1b2c3d4e5f6a7b8c9d0/recipients\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`." } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "maxLength": 64, "example": "generic" }, "in": "query", "name": "platform", "required": false, "description": "Source system name (default `generic`); products are matched on (platform, externalId)." }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "connectionId", "required": false, "description": "Optional source connection id. Defaults to `public-api:`." }, { "schema": { "type": "string", "example": "demo" }, "in": "header", "name": "x-tenant-id", "required": true, "description": "Tenant subdomain or MongoDB ObjectId (required)." } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true } } } } } }, "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X POST \"https://api.inaiy.com/api/public/v1/commerce/catalog/products\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/commerce/catalog/products\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/commerce/catalog/products\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.post(\"https://api.inaiy.com/api/public/v1/commerce/catalog/products\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/commerce/catalog/products\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"POST\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "`." } } } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "example": "demo" }, "in": "header", "name": "x-tenant-id", "required": true, "description": "Tenant subdomain or MongoDB ObjectId (required)." } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X POST \"https://api.inaiy.com/api/public/v1/commerce/catalog/products/batch\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/commerce/catalog/products/batch\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/commerce/catalog/products/batch\", {\n method: \"POST\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.post(\"https://api.inaiy.com/api/public/v1/commerce/catalog/products/batch\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/commerce/catalog/products/batch\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"POST\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": " response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Paginated list of agents", "content": { "application/json": { "schema": { "description": "Paginated list of agents", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "description": "Use as `assignedAgentId` on contacts and conversations.", "example": "6650a1b2c3d4e5f6a7b8c9d5" }, "name": { "type": [ "null", "string" ], "example": "Priya Raman" }, "firstName": { "type": [ "null", "string" ], "example": "Priya" }, "lastName": { "type": [ "null", "string" ], "example": "Raman" }, "email": { "type": [ "null", "string" ], "example": "priya@example.com" }, "status": { "type": [ "null", "string" ], "enum": [ "ACTIVE", "INVITED", "INACTIVE", "SUSPENDED", null ], "example": "ACTIVE" }, "department": { "type": [ "null", "string" ], "example": "Support" }, "designation": { "type": [ "null", "string" ], "example": "Agent" }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time" } } } }, "pagination": { "type": "object", "additionalProperties": true, "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 3 }, "totalPages": { "type": "integer", "example": 1 }, "hasNextPage": { "type": "boolean", "example": false }, "hasPrevPage": { "type": "boolean", "example": false }, "nextCursor": { "type": [ "null", "string" ], "example": null }, "prevCursor": { "type": [ "null", "string" ], "example": null } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/agents\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/agents\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/agents\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/agents\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/agents\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "The agent", "content": { "application/json": { "schema": { "description": "The agent", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "description": "Use as `assignedAgentId` on contacts and conversations.", "example": "6650a1b2c3d4e5f6a7b8c9d5" }, "name": { "type": [ "null", "string" ], "example": "Priya Raman" }, "firstName": { "type": [ "null", "string" ], "example": "Priya" }, "lastName": { "type": [ "null", "string" ], "example": "Raman" }, "email": { "type": [ "null", "string" ], "example": "priya@example.com" }, "status": { "type": [ "null", "string" ], "enum": [ "ACTIVE", "INVITED", "INACTIVE", "SUSPENDED", null ], "example": "ACTIVE" }, "department": { "type": [ "null", "string" ], "example": "Support" }, "designation": { "type": [ "null", "string" ], "example": "Agent" }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "description": "Resource not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/agents/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/agents/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/agents/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/agents/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/agents/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Paginated list of teams", "content": { "application/json": { "schema": { "description": "Paginated list of teams", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "description": "Use as `primaryTeamId` on contacts.", "example": "6650a1b2c3d4e5f6a7b8c9d4" }, "name": { "type": [ "null", "string" ], "example": "Support" }, "description": { "type": [ "null", "string" ], "example": "Tier 1 support" }, "status": { "type": [ "null", "string" ], "example": "ACTIVE" }, "managerId": { "type": [ "null", "string" ], "example": "6650a1b2c3d4e5f6a7b8c9d5" }, "memberIds": { "type": "array", "items": { "type": "string" }, "example": [ "6650a1b2c3d4e5f6a7b8c9d5" ] }, "memberCount": { "type": "integer", "example": 1 }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time" } } } }, "pagination": { "type": "object", "additionalProperties": true, "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 3 }, "totalPages": { "type": "integer", "example": 1 }, "hasNextPage": { "type": "boolean", "example": false }, "hasPrevPage": { "type": "boolean", "example": false }, "nextCursor": { "type": [ "null", "string" ], "example": null }, "prevCursor": { "type": [ "null", "string" ], "example": null } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/teams\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/teams\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/teams\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/teams\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/teams\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "The team", "content": { "application/json": { "schema": { "description": "The team", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "description": "Use as `primaryTeamId` on contacts.", "example": "6650a1b2c3d4e5f6a7b8c9d4" }, "name": { "type": [ "null", "string" ], "example": "Support" }, "description": { "type": [ "null", "string" ], "example": "Tier 1 support" }, "status": { "type": [ "null", "string" ], "example": "ACTIVE" }, "managerId": { "type": [ "null", "string" ], "example": "6650a1b2c3d4e5f6a7b8c9d5" }, "memberIds": { "type": "array", "items": { "type": "string" }, "example": [ "6650a1b2c3d4e5f6a7b8c9d5" ] }, "memberCount": { "type": "integer", "example": 1 }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "description": "Resource not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/teams/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/teams/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/teams/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/teams/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/teams/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Messaging analytics", "content": { "application/json": { "schema": { "description": "Messaging analytics", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "range": { "type": "object", "additionalProperties": true, "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "timezone": { "type": "string", "example": "UTC" } } }, "totals": { "type": "object", "additionalProperties": true, "properties": { "total": { "type": "integer", "example": 1240 }, "inbound": { "type": "integer", "example": 410 }, "outbound": { "type": "integer", "example": 830 }, "sent": { "type": "integer", "description": "Outbound messages that reached sent, delivered or read.", "example": 812 }, "delivered": { "type": "integer", "description": "Outbound messages that reached delivered or read.", "example": 790 }, "read": { "type": "integer", "example": 512 }, "failed": { "type": "integer", "example": 18 }, "broadcast": { "type": "integer", "description": "Outbound messages sent by broadcasts.", "example": 600 }, "session": { "type": "integer", "description": "Other outbound messages (agent, API, automation).", "example": 230 }, "deliveryRatePercent": { "type": [ "null", "number" ], "example": 97.29 }, "readRatePercent": { "type": [ "null", "number" ], "example": 63.05 }, "failureRatePercent": { "type": [ "null", "number" ], "example": 2.17 } } }, "byDay": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "date": { "type": "string", "example": "2026-10-28" }, "total": { "type": "integer", "example": 1240 }, "inbound": { "type": "integer", "example": 410 }, "outbound": { "type": "integer", "example": 830 }, "sent": { "type": "integer", "description": "Outbound messages that reached sent, delivered or read.", "example": 812 }, "delivered": { "type": "integer", "description": "Outbound messages that reached delivered or read.", "example": 790 }, "read": { "type": "integer", "example": 512 }, "failed": { "type": "integer", "example": 18 }, "broadcast": { "type": "integer", "description": "Outbound messages sent by broadcasts.", "example": 600 }, "session": { "type": "integer", "description": "Other outbound messages (agent, API, automation).", "example": 230 }, "deliveryRatePercent": { "type": [ "null", "number" ], "example": 97.29 }, "readRatePercent": { "type": [ "null", "number" ], "example": 63.05 }, "failureRatePercent": { "type": [ "null", "number" ], "example": 2.17 } } } }, "byChannel": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "channelId": { "type": "string" }, "channelType": { "type": [ "null", "string" ], "example": "WHATSAPP" }, "channelName": { "type": [ "null", "string" ] }, "total": { "type": "integer", "example": 1240 }, "inbound": { "type": "integer", "example": 410 }, "outbound": { "type": "integer", "example": 830 }, "sent": { "type": "integer", "description": "Outbound messages that reached sent, delivered or read.", "example": 812 }, "delivered": { "type": "integer", "description": "Outbound messages that reached delivered or read.", "example": 790 }, "read": { "type": "integer", "example": 512 }, "failed": { "type": "integer", "example": 18 }, "broadcast": { "type": "integer", "description": "Outbound messages sent by broadcasts.", "example": 600 }, "session": { "type": "integer", "description": "Other outbound messages (agent, API, automation).", "example": 230 }, "deliveryRatePercent": { "type": [ "null", "number" ], "example": 97.29 }, "readRatePercent": { "type": [ "null", "number" ], "example": 63.05 }, "failureRatePercent": { "type": [ "null", "number" ], "example": 2.17 } } } }, "byType": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "type": { "type": "string", "example": "template" }, "total": { "type": "integer" }, "inbound": { "type": "integer" }, "outbound": { "type": "integer" } } } } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/analytics/messages\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/messages\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/messages\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/analytics/messages\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/analytics/messages\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Template analytics", "content": { "application/json": { "schema": { "description": "Template analytics", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "range": { "type": "object", "additionalProperties": true, "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "timezone": { "type": "string", "example": "UTC" } } }, "totals": { "type": "object", "additionalProperties": true, "properties": { "sent": { "type": "integer", "example": 500 }, "delivered": { "type": "integer", "example": 480 }, "read": { "type": "integer", "example": 300 }, "failed": { "type": "integer", "example": 6 }, "pending": { "type": "integer", "description": "Accepted but not yet sent.", "example": 0 }, "clicks": { "type": "integer", "description": "Quick-reply button taps on these messages.", "example": 42 }, "deliveryRatePercent": { "type": [ "null", "number" ] }, "readRatePercent": { "type": [ "null", "number" ], "description": "Read / delivered." }, "failureRatePercent": { "type": [ "null", "number" ] }, "clickRatePercent": { "type": [ "null", "number" ], "description": "Clicks / delivered." } } }, "templates": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "example": "order_update" }, "language": { "type": [ "null", "string" ], "example": "en_US" }, "category": { "type": [ "null", "string" ], "example": "UTILITY" }, "templateId": { "type": [ "null", "string" ] }, "lastSentAt": { "type": [ "null", "string" ], "format": "date-time" }, "sent": { "type": "integer", "example": 500 }, "delivered": { "type": "integer", "example": 480 }, "read": { "type": "integer", "example": 300 }, "failed": { "type": "integer", "example": 6 }, "pending": { "type": "integer", "description": "Accepted but not yet sent.", "example": 0 }, "clicks": { "type": "integer", "description": "Quick-reply button taps on these messages.", "example": 42 }, "deliveryRatePercent": { "type": [ "null", "number" ] }, "readRatePercent": { "type": [ "null", "number" ], "description": "Read / delivered." }, "failureRatePercent": { "type": [ "null", "number" ] }, "clickRatePercent": { "type": [ "null", "number" ], "description": "Clicks / delivered." }, "buttons": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "text": { "type": "string", "example": "Track order" }, "clicks": { "type": "integer", "example": 30 } } } } } } }, "byDay": { "type": "array", "description": "Only when `name` is given.", "items": { "type": "object", "additionalProperties": true } }, "truncated": { "type": "boolean", "description": "True when the result was capped (over 500 templates or 20,000 button taps)." } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/analytics/templates\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/templates\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/templates\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/analytics/templates\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/analytics/templates\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Broadcast analytics summary", "content": { "application/json": { "schema": { "description": "Broadcast analytics summary", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "summary": { "type": [ "null", "object" ], "additionalProperties": true, "description": "Totals and rates across all matching broadcasts." }, "highlights": { "type": [ "null", "object" ], "additionalProperties": true }, "broadcasts": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ], "example": "COMPLETED" }, "templateId": { "type": [ "null", "string" ] }, "templateName": { "type": [ "null", "string" ] }, "totalRecipients": { "type": "integer" }, "sent": { "type": "integer" }, "delivered": { "type": "integer" }, "read": { "type": "integer" }, "failed": { "type": "integer" }, "successRate": { "type": "number" }, "failureRate": { "type": "number" }, "deliveryRate": { "type": "number" }, "readRate": { "type": "number" }, "startedAt": { "type": [ "null", "string" ], "format": "date-time" } } } }, "pagination": { "type": "object", "additionalProperties": true }, "truncated": { "type": "boolean" } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/analytics/broadcasts\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/broadcasts\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/broadcasts\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/analytics/broadcasts\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/analytics/broadcasts\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Inbox analytics", "content": { "application/json": { "schema": { "description": "Inbox analytics", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "range": { "type": "object", "additionalProperties": true, "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "timezone": { "type": "string", "example": "UTC" } } }, "overview": { "type": "object", "additionalProperties": true, "properties": { "total": { "type": "integer" }, "open": { "type": "integer" }, "pending": { "type": "integer" }, "resolved": { "type": "integer" }, "closed": { "type": "integer" }, "unassigned": { "type": "integer" }, "avgFirstResponseMs": { "type": [ "null", "number" ] }, "avgResolutionHours": { "type": [ "null", "number" ] } } }, "breakdowns": { "type": "object", "additionalProperties": true }, "agents": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "agentId": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "open": { "type": "integer" }, "pending": { "type": "integer" }, "resolved": { "type": "integer" }, "closed": { "type": "integer" }, "total": { "type": "integer" }, "avgFirstResponseMs": { "type": [ "null", "number" ] } } } }, "messages": { "type": "object", "additionalProperties": true }, "sla": { "type": "object", "additionalProperties": true } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/analytics/inbox\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/inbox\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/inbox\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/analytics/inbox\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/analytics/inbox\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Plan usage", "content": { "application/json": { "schema": { "description": "Plan usage", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "period": { "type": [ "null", "string" ], "example": "2026-10" }, "plan": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] } } }, "metrics": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "key": { "type": "string", "example": "messages_per_month" }, "label": { "type": "string", "example": "Messages Per Month" }, "used": { "type": "number", "example": 1200 }, "limit": { "type": [ "null", "number" ], "description": "Null when unlimited.", "example": 10000 }, "remaining": { "type": [ "null", "number" ] }, "percentUsed": { "type": [ "null", "number" ] }, "unlimited": { "type": "boolean" }, "resetsMonthly": { "type": "boolean" } } } } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/analytics/usage\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/usage\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/usage\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/analytics/usage\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/analytics/usage\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Commerce report", "content": { "application/json": { "schema": { "description": "Commerce report", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/analytics/commerce/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/commerce/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/commerce/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/analytics/commerce/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/analytics/commerce/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Drip campaigns", "content": { "application/json": { "schema": { "description": "Drip campaigns", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ], "example": "RUNNING" }, "channelId": { "type": [ "null", "string" ] }, "stepCount": { "type": "integer" }, "counts": { "type": "object", "additionalProperties": true, "properties": { "enrolled": { "type": "integer" }, "completed": { "type": "integer" }, "stoppedReply": { "type": "integer" }, "stoppedOptOut": { "type": "integer" }, "failed": { "type": "integer" }, "cancelled": { "type": "integer" } } }, "startedAt": { "type": [ "null", "string" ], "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" } } } }, "pagination": { "type": "object", "additionalProperties": true, "properties": { "page": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 3 }, "totalPages": { "type": "integer", "example": 1 }, "hasNextPage": { "type": "boolean", "example": false }, "hasPrevPage": { "type": "boolean", "example": false }, "nextCursor": { "type": [ "null", "string" ], "example": null }, "prevCursor": { "type": [ "null", "string" ], "example": null } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/analytics/drips\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/drips\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/drips\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/analytics/drips\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/analytics/drips\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Drip step analytics", "content": { "application/json": { "schema": { "description": "Drip step analytics", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "drip": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ], "example": "RUNNING" }, "channelId": { "type": [ "null", "string" ] }, "stepCount": { "type": "integer" }, "counts": { "type": "object", "additionalProperties": true, "properties": { "enrolled": { "type": "integer" }, "completed": { "type": "integer" }, "stoppedReply": { "type": "integer" }, "stoppedOptOut": { "type": "integer" }, "failed": { "type": "integer" }, "cancelled": { "type": "integer" } } }, "startedAt": { "type": [ "null", "string" ], "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "totalEnrollments": { "type": "integer" }, "enrollmentsByStatus": { "type": "object", "additionalProperties": true }, "steps": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "order": { "type": "integer" }, "templateId": { "type": [ "null", "string" ] }, "templateName": { "type": [ "null", "string" ] }, "delayMs": { "type": "integer" }, "sent": { "type": "integer" }, "failed": { "type": "integer" }, "queued": { "type": "integer" } } } } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "description": "Resource not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/analytics/drips/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/drips/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/drips/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/analytics/drips/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/analytics/drips/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "AI agent analytics", "content": { "application/json": { "schema": { "description": "AI agent analytics", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "sinceDays": { "type": "integer" }, "agents": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ], "example": "LIVE" }, "mode": { "type": [ "null", "string" ] }, "channelId": { "type": [ "null", "string" ] }, "conversationsTouched": { "type": "integer" }, "replies": { "type": "integer", "description": "Turns the AI answered." }, "handoffs": { "type": "integer", "description": "Turns escalated to a human." }, "unanswered": { "type": "integer" }, "skipped": { "type": "integer" }, "containmentRate": { "type": [ "null", "number" ], "description": "Replies / (replies + handoffs + no-answer), 0-1." }, "escalationTotal": { "type": "integer" }, "tokens": { "type": "object", "additionalProperties": true, "properties": { "prompt": { "type": "integer" }, "completion": { "type": "integer" }, "total": { "type": "integer" } } } } } } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/analytics/ai-agents\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/ai-agents\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/ai-agents\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/analytics/ai-agents\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/analytics/ai-agents\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "AI agent analytics", "content": { "application/json": { "schema": { "description": "AI agent analytics", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "agentId": { "type": "string" }, "sinceDays": { "type": "integer" }, "conversationsTouched": { "type": "integer" }, "replies": { "type": "integer", "description": "Turns the AI answered." }, "handoffs": { "type": "integer", "description": "Turns escalated to a human." }, "unanswered": { "type": "integer" }, "skipped": { "type": "integer" }, "containmentRate": { "type": [ "null", "number" ], "description": "Replies / (replies + handoffs + no-answer), 0-1." }, "escalationTotal": { "type": "integer" }, "tokens": { "type": "object", "additionalProperties": true, "properties": { "prompt": { "type": "integer" }, "completion": { "type": "integer" }, "total": { "type": "integer" } } }, "escalationBreakdown": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "csat": { "type": [ "null", "object" ], "additionalProperties": true }, "topUnanswered": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "description": "Resource not found", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/analytics/ai-agents/6650a1b2c3d4e5f6a7b8c9d0\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/ai-agents/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/ai-agents/6650a1b2c3d4e5f6a7b8c9d0\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/analytics/ai-agents/6650a1b2c3d4e5f6a7b8c9d0\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/analytics/ai-agents/6650a1b2c3d4e5f6a7b8c9d0\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "` for an OAuth app." }, { "schema": { "type": "string", "example": "demo" }, "in": "header", "name": "x-tenant-id", "required": true, "description": "Tenant subdomain or MongoDB ObjectId (required)." }, { "schema": { "type": "string", "example": "Bearer wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "authorization", "required": false, "description": "API key as `Bearer ` or an OAuth access token. Alternatively use the X-API-Key header." }, { "schema": { "type": "string", "example": "wp_live_a1b2c3d4e5f6g7h8..." }, "in": "header", "name": "x-api-key", "required": false, "description": "API key (alternative to Authorization: Bearer)." } ], "responses": { "200": { "description": "Public API usage", "content": { "application/json": { "schema": { "description": "Public API usage", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "additionalProperties": true, "properties": { "range": { "type": "object", "additionalProperties": true, "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "timezone": { "type": "string", "example": "UTC" } } }, "totals": { "type": "object", "additionalProperties": true, "properties": { "calls": { "type": "integer", "example": 10520 }, "success": { "type": "integer", "example": 10220 }, "errors": { "type": "integer", "example": 300 }, "clientErrors": { "type": "integer", "example": 297 }, "serverErrors": { "type": "integer", "example": 3 }, "rateLimited": { "type": "integer", "example": 0 }, "successRatePercent": { "type": [ "null", "number" ] }, "errorRatePercent": { "type": [ "null", "number" ] }, "avgLatencyMs": { "type": [ "null", "integer" ], "example": 84 }, "p95LatencyMs": { "type": [ "null", "integer" ], "example": 240 } } }, "byDay": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "byEndpoint": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "byKey": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "byStatus": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "quota": { "type": [ "null", "object" ], "additionalProperties": true } } }, "meta": { "type": "object", "additionalProperties": true, "properties": { "apiVersion": { "type": "string", "example": "v1" } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Malformed request or missing tenant context", "content": { "application/json": { "schema": { "description": "Malformed request or missing tenant context", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "401": { "description": "Missing or invalid API key / access token", "content": { "application/json": { "schema": { "description": "Missing or invalid API key / access token", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "403": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "content": { "application/json": { "schema": { "description": "Forbidden — plan, scope, key status, or tenant mismatch", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "description": "Validation failed", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "429": { "description": "Too many requests — rate limit exceeded", "content": { "application/json": { "schema": { "description": "Too many requests — rate limit exceeded", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "description": "Unexpected server error", "type": "object", "additionalProperties": true, "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": true } } }, "requestId": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" }, "path": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] } } } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \"https://api.inaiy.com/api/public/v1/analytics/api-usage\" \\\n -H \"x-tenant-id: demo\" \\\n -H \"x-api-key: wp_live_xxxxxxxxxxxxxxxxxxxx\"" }, { "lang": "JavaScript", "label": "JavaScript", "source": "const res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/api-usage\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconst data = await res.json();\nconsole.log(data);" }, { "lang": "Node.js", "label": "Node.js", "source": "import https from \"node:https\";\n\nconst res = await fetch(\"https://api.inaiy.com/api/public/v1/analytics/api-usage\", {\n method: \"GET\",\n headers: {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\"\n }\n});\nconsole.log(await res.json());" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nheaders = {\n \"x-tenant-id\": \"demo\",\n \"x-api-key\": \"wp_live_xxxxxxxxxxxxxxxxxxxx\",\n}\nres = requests.get(\"https://api.inaiy.com/api/public/v1/analytics/api-usage\", headers=headers)\nprint(res.json())" }, { "lang": "Java", "label": "Java", "source": "HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.inaiy.com/api/public/v1/analytics/api-usage\"))\n .header(\"x-tenant-id\", \"demo\")\n .header(\"x-api-key\", \"wp_live_xxxxxxxxxxxxxxxxxxxx\")\n .method(\"GET\", HttpRequest.BodyPublishers.noBody())\n .build();\nHttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": " response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": " response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": " response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": " response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": " response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());" }, { "lang": "PHP", "label": "PHP", "source": "