# MCP tool reference 1 callable tools. Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference. Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result. [Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt) ## read_heyreach Read the workspace's HeyReach LinkedIn automation as it is right now: the connection, sender accounts and their session status, campaigns with their sequences and enrolled leads, lists, lead tags, synced LinkedIn conversations, a sender's network, activity statistics, an email-enrichment job, and the webhook deliveries this workspace received. Use before proposing any LinkedIn outreach change — every read is a live provider read with the workspace's own key, so it is the only honest answer to what HeyReach is doing. Page through campaigns, lists, leads, and network with offset/limit; conversation search pages with the provider cursor. Nothing is cached locally: a read costs a HeyReach API call and HeyReach rate-limits the workspace, so do not poll tight loops. `HeyReachNotConnected` means the workspace has no key — a person must connect one in Settings. HeyReach's own documents (sequences, account status, lead lookups, per-campaign statistics) come back verbatim as provider JSON. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "connection" ] } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId|target)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "proxy_countries" ] } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId|target)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "webhooks" ] } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId|target)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "accounts" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId|target|offset|limit|keyword)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "offset", "limit", "keyword" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "account" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "accountId" ], "patternProperties": { "^(?!(?:workspaceId|target|accountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "accountId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "account_status" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "accountId" ], "patternProperties": { "^(?!(?:workspaceId|target|accountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "accountId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "network" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "pageNumber": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "accountId" ], "patternProperties": { "^(?!(?:workspaceId|target|accountId|pageNumber|pageSize)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "accountId", "pageNumber", "pageSize" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "campaigns" ] }, "campaignSearch": { "$ref": "#/$defs/SearchHeyReachCampaignsInput" } }, "required": [ "workspaceId", "target", "campaignSearch" ], "patternProperties": { "^(?!(?:workspaceId|target|campaignSearch)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "campaignSearch" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "campaign" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|target|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "campaignId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "campaign_sequence" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|target|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "campaignId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "campaign_leads" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|target|campaignId|offset|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "campaignId", "offset", "limit" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "campaigns_for_lead" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId|target|profileUrl|offset|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "profileUrl", "offset", "limit" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "lists" ] }, "listSearch": { "$ref": "#/$defs/SearchHeyReachListsInput" } }, "required": [ "workspaceId", "target", "listSearch" ], "patternProperties": { "^(?!(?:workspaceId|target|listSearch)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "listSearch" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "list" ] }, "listId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "listId" ], "patternProperties": { "^(?!(?:workspaceId|target|listId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "listId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "list_leads" ] }, "listId": { "$ref": "#/$defs/HeyReachId" }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "listId" ], "patternProperties": { "^(?!(?:workspaceId|target|listId|offset|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "listId", "offset", "limit" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "lead" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "target", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId|target|profileUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "profileUrl" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "lead_tags" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "target", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId|target|profileUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "profileUrl" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "conversations" ] }, "conversationSearch": { "$ref": "#/$defs/SearchHeyReachConversationsInput" } }, "required": [ "workspaceId", "target", "conversationSearch" ], "patternProperties": { "^(?!(?:workspaceId|target|conversationSearch)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "conversationSearch" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "conversation" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "conversationId": { "$ref": "#/$defs/HeyReachConversationId" } }, "required": [ "workspaceId", "target", "accountId", "conversationId" ], "patternProperties": { "^(?!(?:workspaceId|target|accountId|conversationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "accountId", "conversationId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "is_connection" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "target", "accountId", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId|target|accountId|profileUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "accountId", "profileUrl" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "stats" ] }, "stats": { "$ref": "#/$defs/HeyReachStatsInput" } }, "required": [ "workspaceId", "target", "stats" ], "patternProperties": { "^(?!(?:workspaceId|target|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "stats" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "stats_by_campaign" ] }, "stats": { "$ref": "#/$defs/HeyReachStatsInput" } }, "required": [ "workspaceId", "target", "stats" ], "patternProperties": { "^(?!(?:workspaceId|target|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "stats" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "enrichment_job" ] }, "jobId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "jobId" ], "patternProperties": { "^(?!(?:workspaceId|target|jobId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "jobId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "events" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId|target|offset|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "offset", "limit" ] } } ], "$defs": { "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "HeyReachCampaignStatus": { "type": "string", "enum": [ "DRAFT", "IN_PROGRESS", "PAUSED", "FINISHED", "CANCELED", "FAILED", "STARTING", "SCHEDULED" ] }, "SearchHeyReachCampaignsInput": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 200 }, "statuses": { "type": "array", "items": { "$ref": "#/$defs/HeyReachCampaignStatus" }, "maxItems": 8 }, "accountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 } }, "patternProperties": { "^(?!(?:offset|limit|keyword|statuses|accountIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "keyword", "statuses", "accountIds" ] } }, "LinkedInProfileUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "HeyReachListType": { "type": "string", "enum": [ "USER_LIST", "COMPANY_LIST" ] }, "SearchHeyReachListsInput": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 200 }, "listType": { "$ref": "#/$defs/HeyReachListType" }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 } }, "patternProperties": { "^(?!(?:offset|limit|keyword|listType|campaignIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "keyword", "listType", "campaignIds" ] } }, "HeyReachInstant": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d+)?)?(?:Z|[+-]\\d{2}:\\d{2})$" }, "SearchHeyReachConversationsInput": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4000 }, { "type": "null" } ] }, "from": { "$ref": "#/$defs/HeyReachInstant" }, "to": { "$ref": "#/$defs/HeyReachInstant" }, "filters": { "type": "object", "properties": { "linkedInAccountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "searchString": { "type": "string", "minLength": 0, "maxLength": 500 }, "leadLinkedInId": { "type": "string", "minLength": 1, "maxLength": 200 }, "leadProfileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "tags": { "type": "array", "items": { "type": "string", "minLength": 0, "maxLength": 100 }, "maxItems": 100 }, "latestAutoTagNames": { "type": "array", "items": { "type": "string", "minLength": 0, "maxLength": 100 }, "maxItems": 100 }, "seen": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:linkedInAccountIds|campaignIds|searchString|leadLinkedInId|leadProfileUrl|tags|latestAutoTagNames|seen)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "linkedInAccountIds", "campaignIds", "searchString", "leadLinkedInId", "leadProfileUrl", "tags", "latestAutoTagNames", "seen" ] } } }, "patternProperties": { "^(?!(?:limit|cursor|from|to|filters)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "limit", "cursor", "from", "to", "filters" ] } }, "HeyReachConversationId": { "type": "string", "minLength": 1, "maxLength": 2000 }, "HeyReachStatsInput": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "startDate": { "$ref": "#/$defs/HeyReachInstant" }, "endDate": { "$ref": "#/$defs/HeyReachInstant" } }, "required": [ "startDate", "endDate" ], "patternProperties": { "^(?!(?:accountIds|campaignIds|startDate|endDate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "accountIds", "campaignIds", "startDate", "endDate" ] } } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "workspaceId": { "type": "string", "format": "uuid", "description": "Target Workspace UUID. Call list_workspaces to enumerate the Workspaces this credential may access, then pass the chosen id here." } }, "required": [ "workspaceId" ], "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "connection" ] } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "proxy_countries" ] } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "webhooks" ] } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "accounts" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|offset|limit|keyword)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "offset", "limit", "keyword" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "account" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "accountId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|accountId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "accountId" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "account_status" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "accountId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|accountId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "accountId" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "network" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "pageNumber": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "accountId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|accountId|pageNumber|pageSize)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "accountId", "pageNumber", "pageSize" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "campaigns" ] }, "campaignSearch": { "$ref": "#/$defs/SearchHeyReachCampaignsInput" } }, "required": [ "workspaceId", "target", "campaignSearch" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|campaignSearch)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "campaignSearch" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "campaign" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "campaignId" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "campaign_sequence" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "campaignId" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "campaign_leads" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|campaignId|offset|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "campaignId", "offset", "limit" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "campaigns_for_lead" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|profileUrl|offset|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "profileUrl", "offset", "limit" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "lists" ] }, "listSearch": { "$ref": "#/$defs/SearchHeyReachListsInput" } }, "required": [ "workspaceId", "target", "listSearch" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|listSearch)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "listSearch" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "list" ] }, "listId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "listId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|listId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "listId" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "list_leads" ] }, "listId": { "$ref": "#/$defs/HeyReachId" }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "listId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|listId|offset|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "listId", "offset", "limit" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "lead" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "target", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|profileUrl)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "profileUrl" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "lead_tags" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "target", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|profileUrl)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "profileUrl" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "conversations" ] }, "conversationSearch": { "$ref": "#/$defs/SearchHeyReachConversationsInput" } }, "required": [ "workspaceId", "target", "conversationSearch" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|conversationSearch)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "conversationSearch" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "conversation" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "conversationId": { "$ref": "#/$defs/HeyReachConversationId" } }, "required": [ "workspaceId", "target", "accountId", "conversationId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|accountId|conversationId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "accountId", "conversationId" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "is_connection" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "target", "accountId", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|accountId|profileUrl)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "accountId", "profileUrl" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "stats" ] }, "stats": { "$ref": "#/$defs/HeyReachStatsInput" } }, "required": [ "workspaceId", "target", "stats" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|stats)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "stats" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "stats_by_campaign" ] }, "stats": { "$ref": "#/$defs/HeyReachStatsInput" } }, "required": [ "workspaceId", "target", "stats" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|stats)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "stats" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "enrichment_job" ] }, "jobId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "jobId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|jobId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "jobId" ] }, { "enum": [ "workspaceId" ] } ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "target": { "type": "string", "enum": [ "events" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|offset|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "offset", "limit" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "HeyReachCampaignStatus": { "type": "string", "enum": [ "DRAFT", "IN_PROGRESS", "PAUSED", "FINISHED", "CANCELED", "FAILED", "STARTING", "SCHEDULED" ] }, "SearchHeyReachCampaignsInput": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 200 }, "statuses": { "type": "array", "items": { "$ref": "#/$defs/HeyReachCampaignStatus" }, "maxItems": 8 }, "accountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 } }, "patternProperties": { "^(?!(?:offset|limit|keyword|statuses|accountIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "keyword", "statuses", "accountIds" ] } }, "LinkedInProfileUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "HeyReachListType": { "type": "string", "enum": [ "USER_LIST", "COMPANY_LIST" ] }, "SearchHeyReachListsInput": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 200 }, "listType": { "$ref": "#/$defs/HeyReachListType" }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 } }, "patternProperties": { "^(?!(?:offset|limit|keyword|listType|campaignIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "keyword", "listType", "campaignIds" ] } }, "HeyReachInstant": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d+)?)?(?:Z|[+-]\\d{2}:\\d{2})$" }, "SearchHeyReachConversationsInput": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4000 }, { "type": "null" } ] }, "from": { "$ref": "#/$defs/HeyReachInstant" }, "to": { "$ref": "#/$defs/HeyReachInstant" }, "filters": { "type": "object", "properties": { "linkedInAccountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "searchString": { "type": "string", "minLength": 0, "maxLength": 500 }, "leadLinkedInId": { "type": "string", "minLength": 1, "maxLength": 200 }, "leadProfileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "tags": { "type": "array", "items": { "type": "string", "minLength": 0, "maxLength": 100 }, "maxItems": 100 }, "latestAutoTagNames": { "type": "array", "items": { "type": "string", "minLength": 0, "maxLength": 100 }, "maxItems": 100 }, "seen": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:linkedInAccountIds|campaignIds|searchString|leadLinkedInId|leadProfileUrl|tags|latestAutoTagNames|seen)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "linkedInAccountIds", "campaignIds", "searchString", "leadLinkedInId", "leadProfileUrl", "tags", "latestAutoTagNames", "seen" ] } } }, "patternProperties": { "^(?!(?:limit|cursor|from|to|filters)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "limit", "cursor", "from", "to", "filters" ] } }, "HeyReachConversationId": { "type": "string", "minLength": 1, "maxLength": 2000 }, "HeyReachStatsInput": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "startDate": { "$ref": "#/$defs/HeyReachInstant" }, "endDate": { "$ref": "#/$defs/HeyReachInstant" } }, "required": [ "startDate", "endDate" ], "patternProperties": { "^(?!(?:accountIds|campaignIds|startDate|endDate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "accountIds", "campaignIds", "startDate", "endDate" ] } } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "HeyReachConnectionStatus": { "type": "object", "properties": { "connected": { "type": "boolean" }, "replyWebhookReady": { "type": "boolean" }, "connectionId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "credential": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "provider": { "$ref": "#/$defs/NonEmptyString" }, "kind": { "$ref": "#/$defs/NonEmptyString" }, "status": { "type": "string", "enum": [ "connected", "needs_reauthorization", "disabled", "disconnected" ] }, "fingerprint": { "$ref": "#/$defs/NonEmptyString" }, "lastFour": { "type": "string", "pattern": "^.{4}$" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "lastUsedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "provider", "kind", "status", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|provider|kind|status|fingerprint|lastFour|createdAt|updatedAt|lastUsedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "provider", "kind", "status", "fingerprint", "lastFour", "createdAt", "updatedAt", "lastUsedAt" ] } }, { "type": "null" } ] }, "connectedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastCheckedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "connected", "replyWebhookReady", "connectionId", "credential", "connectedAt", "lastCheckedAt" ], "patternProperties": { "^(?!(?:connected|replyWebhookReady|connectionId|credential|connectedAt|lastCheckedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connected", "replyWebhookReady", "connectionId", "credential", "connectedAt", "lastCheckedAt" ] } }, "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "HeyReachText": { "type": "string", "minLength": 0, "maxLength": 10000 }, "HeyReachAccount": { "type": "object", "properties": { "id": { "$ref": "#/$defs/HeyReachId" }, "firstName": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "profileUrl": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "isActive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "authIsValid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "activeCampaigns": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "isValidNavigator": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isValidRecruiter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "accountLimits": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "number" } }, { "type": "null" } ] } }, "required": [ "id", "firstName", "lastName", "emailAddress", "profileUrl", "isActive", "authIsValid", "activeCampaigns", "isValidNavigator", "isValidRecruiter", "accountLimits" ], "patternProperties": { "^(?!(?:id|firstName|lastName|emailAddress|profileUrl|isActive|authIsValid|activeCampaigns|isValidNavigator|isValidRecruiter|accountLimits)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "firstName", "lastName", "emailAddress", "profileUrl", "isActive", "authIsValid", "activeCampaigns", "isValidNavigator", "isValidRecruiter", "accountLimits" ] } }, "HeyReachAccountPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachAccount" }, "maxItems": 100 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "totalCount" ], "patternProperties": { "^(?!(?:items|totalCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount" ] } }, "HeyReachProxyCountryList": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/$defs/HeyReachText" }, "code": { "$ref": "#/$defs/HeyReachText" } }, "required": [ "name", "code" ], "patternProperties": { "^(?!(?:name|code)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "code" ] } }, "maxItems": 500 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, "HeyReachCampaign": { "type": "object", "properties": { "id": { "$ref": "#/$defs/HeyReachId" }, "name": { "$ref": "#/$defs/HeyReachText" }, "status": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "creationTime": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "linkedInUserListId": { "anyOf": [ { "$ref": "#/$defs/HeyReachId" }, { "type": "null" } ] }, "linkedInUserListName": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "campaignAccountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "maxItems": 1000 }, "progressStats": { "anyOf": [ { "type": "object", "properties": { "totalUsers": { "type": "number", "minimum": 0 }, "totalUsersInProgress": { "type": "number", "minimum": 0 }, "totalUsersPending": { "type": "number", "minimum": 0 }, "totalUsersFinished": { "type": "number", "minimum": 0 }, "totalUsersFailed": { "type": "number", "minimum": 0 } }, "required": [ "totalUsers", "totalUsersInProgress", "totalUsersPending", "totalUsersFinished", "totalUsersFailed" ], "patternProperties": { "^(?!(?:totalUsers|totalUsersInProgress|totalUsersPending|totalUsersFinished|totalUsersFailed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalUsers", "totalUsersInProgress", "totalUsersPending", "totalUsersFinished", "totalUsersFailed" ] } }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "creationTime", "linkedInUserListId", "linkedInUserListName", "campaignAccountIds", "progressStats" ], "patternProperties": { "^(?!(?:id|name|status|creationTime|linkedInUserListId|linkedInUserListName|campaignAccountIds|progressStats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "creationTime", "linkedInUserListId", "linkedInUserListName", "campaignAccountIds", "progressStats" ] } }, "HeyReachCampaignPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachCampaign" }, "maxItems": 100 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "totalCount" ], "patternProperties": { "^(?!(?:items|totalCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount" ] } }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "HeyReachDocument": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "HeyReachDocumentPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachDocument" }, "maxItems": 100 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "totalCount" ], "patternProperties": { "^(?!(?:items|totalCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount" ] } }, "HeyReachList": { "type": "object", "properties": { "id": { "$ref": "#/$defs/HeyReachId" }, "name": { "$ref": "#/$defs/HeyReachText" }, "totalItemsCount": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "count": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "listType": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "creationTime": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "campaignIds": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "maxItems": 1000 }, { "type": "null" } ] } }, "required": [ "id", "name", "totalItemsCount", "count", "listType", "creationTime", "campaignIds" ], "patternProperties": { "^(?!(?:id|name|totalItemsCount|count|listType|creationTime|campaignIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "totalItemsCount", "count", "listType", "creationTime", "campaignIds" ] } }, "HeyReachListPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachList" }, "maxItems": 100 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "totalCount" ], "patternProperties": { "^(?!(?:items|totalCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount" ] } }, "HeyReachLeadTags": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/$defs/HeyReachText" }, "maxItems": 1000 } }, "required": [ "tags" ], "patternProperties": { "^(?!(?:tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "tags" ] } ] } }, "HeyReachConversationId": { "type": "string", "minLength": 1, "maxLength": 2000 }, "HeyReachProfile": { "type": "object", "properties": { "id": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "linkedinId": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "profileUrl": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "headline": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "imageUrl": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "$ref": "#/$defs/HeyReachText" }, "maxItems": 1000 }, "customFields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[A-Za-z0-9_]+$", "maxLength": 100 }, "value": { "type": "string", "minLength": 0, "maxLength": 10000 } }, "required": [ "name", "value" ], "patternProperties": { "^(?!(?:name|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "value" ] } }, "maxItems": 100 } }, "required": [ "id", "linkedinId", "profileUrl", "firstName", "lastName", "headline", "imageUrl", "companyName", "emailAddress", "tags", "customFields" ], "patternProperties": { "^(?!(?:id|linkedinId|profileUrl|firstName|lastName|headline|imageUrl|companyName|emailAddress|tags|customFields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "linkedinId", "profileUrl", "firstName", "lastName", "headline", "imageUrl", "companyName", "emailAddress", "tags", "customFields" ] } }, "HeyReachMessage": { "type": "object", "properties": { "createdAt": { "$ref": "#/$defs/HeyReachText" }, "body": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "subject": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "sender": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "isInMail": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "createdAt", "body", "subject", "sender", "isInMail" ], "patternProperties": { "^(?!(?:createdAt|body|subject|sender|isInMail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "createdAt", "body", "subject", "sender", "isInMail" ] } }, "HeyReachConversation": { "type": "object", "properties": { "id": { "$ref": "#/$defs/HeyReachConversationId" }, "linkedInAccountId": { "$ref": "#/$defs/HeyReachId" }, "read": { "type": "boolean" }, "groupChat": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "blockedByMe": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "blockedByParticipant": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "lastMessageAt": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "lastMessageText": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "lastMessageSender": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "totalMessages": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "campaignId": { "anyOf": [ { "$ref": "#/$defs/HeyReachId" }, { "type": "null" } ] }, "correspondentProfile": { "anyOf": [ { "$ref": "#/$defs/HeyReachProfile" }, { "type": "null" } ] }, "linkedInAccount": { "anyOf": [ { "$ref": "#/$defs/HeyReachAccount" }, { "type": "null" } ] }, "messages": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/HeyReachMessage" }, "maxItems": 1000 }, { "type": "null" } ] } }, "required": [ "id", "linkedInAccountId", "read", "groupChat", "blockedByMe", "blockedByParticipant", "lastMessageAt", "lastMessageText", "lastMessageSender", "totalMessages", "campaignId", "correspondentProfile", "linkedInAccount", "messages" ], "patternProperties": { "^(?!(?:id|linkedInAccountId|read|groupChat|blockedByMe|blockedByParticipant|lastMessageAt|lastMessageText|lastMessageSender|totalMessages|campaignId|correspondentProfile|linkedInAccount|messages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "linkedInAccountId", "read", "groupChat", "blockedByMe", "blockedByParticipant", "lastMessageAt", "lastMessageText", "lastMessageSender", "totalMessages", "campaignId", "correspondentProfile", "linkedInAccount", "messages" ] } }, "HeyReachConversationPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachConversation" }, "maxItems": 100 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextCursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4000 }, { "type": "null" } ] }, "hasNextPage": { "type": "boolean" } }, "required": [ "items", "totalCount", "nextCursor", "hasNextPage" ], "patternProperties": { "^(?!(?:items|totalCount|nextCursor|hasNextPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount", "nextCursor", "hasNextPage" ] } }, "HeyReachConnectionCheck": { "type": "object", "properties": { "isConnection": { "type": "boolean" } }, "required": [ "isConnection" ], "patternProperties": { "^(?!(?:isConnection)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "isConnection" ] } ] } }, "HeyReachStats": { "type": "object", "properties": { "overallStats": { "type": "object", "additionalProperties": { "type": "number" } }, "byDayStats": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } } }, "required": [ "overallStats", "byDayStats" ], "patternProperties": { "^(?!(?:overallStats|byDayStats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "overallStats", "byDayStats" ] } }, "HeyReachEnrichmentJob": { "type": "object", "properties": { "jobId": { "$ref": "#/$defs/HeyReachId" }, "status": { "type": "string", "enum": [ "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED" ] }, "data": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ENRICHED", "EMAIL_NOT_FOUND", "CANCELLED", "FAILED" ] }, "message": { "$ref": "#/$defs/HeyReachText" }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "memberId": { "$ref": "#/$defs/HeyReachText" }, "profileUrl": { "$ref": "#/$defs/HeyReachText" } }, "required": [ "status", "message", "emailAddress", "memberId", "profileUrl" ], "patternProperties": { "^(?!(?:status|message|emailAddress|memberId|profileUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "message", "emailAddress", "memberId", "profileUrl" ] } }, { "type": "null" } ] } }, "required": [ "jobId", "status", "data" ], "patternProperties": { "^(?!(?:jobId|status|data)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "jobId", "status", "data" ] } }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "HeyReachWebhookEventType": { "type": "string", "enum": [ "CONNECTION_REQUEST_SENT", "CONNECTION_REQUEST_ACCEPTED", "MESSAGE_SENT", "MESSAGE_REPLY_RECEIVED", "INMAIL_SENT", "INMAIL_REPLY_RECEIVED", "EVERY_MESSAGE_REPLY_RECEIVED", "FOLLOW_SENT", "LIKED_POST", "VIEWED_PROFILE", "CAMPAIGN_COMPLETED", "LEAD_TAG_UPDATED" ] }, "HeyReachEvent": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "eventType": { "$ref": "#/$defs/HeyReachWebhookEventType" }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "payload": { "$ref": "#/$defs/HeyReachDocument" } }, "required": [ "id", "webhookId", "eventType", "receivedAt", "payload" ], "patternProperties": { "^(?!(?:id|webhookId|eventType|receivedAt|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "eventType", "receivedAt", "payload" ] } }, "HeyReachEventPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachEvent" }, "maxItems": 100 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "totalCount" ], "patternProperties": { "^(?!(?:items|totalCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount" ] } }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HeyReachWebhookStatus": { "type": "string", "enum": [ "pending", "active", "failed", "deleting" ] }, "HeyReachWebhook": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "remoteId": { "anyOf": [ { "$ref": "#/$defs/HeyReachId" }, { "type": "null" } ] }, "name": { "$ref": "#/$defs/ShortText" }, "eventType": { "$ref": "#/$defs/HeyReachWebhookEventType" }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "maxItems": 100 }, "status": { "$ref": "#/$defs/HeyReachWebhookStatus" }, "lastReceivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "remoteId", "name", "eventType", "campaignIds", "status", "lastReceivedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|remoteId|name|eventType|campaignIds|status|lastReceivedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "remoteId", "name", "eventType", "campaignIds", "status", "lastReceivedAt", "createdAt" ] } }, "HeyReachWebhookList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachWebhook" }, "maxItems": 200 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/HeyReachConnectionStatus" }, { "$ref": "#/$defs/HeyReachAccountPage" }, { "$ref": "#/$defs/HeyReachAccount" }, { "$ref": "#/$defs/HeyReachProxyCountryList" }, { "$ref": "#/$defs/HeyReachCampaignPage" }, { "$ref": "#/$defs/HeyReachCampaign" }, { "$ref": "#/$defs/HeyReachDocumentPage" }, { "$ref": "#/$defs/HeyReachListPage" }, { "$ref": "#/$defs/HeyReachList" }, { "$ref": "#/$defs/HeyReachLeadTags" }, { "$ref": "#/$defs/HeyReachConversationPage" }, { "$ref": "#/$defs/HeyReachConversation" }, { "$ref": "#/$defs/HeyReachConnectionCheck" }, { "$ref": "#/$defs/HeyReachStats" }, { "$ref": "#/$defs/HeyReachEnrichmentJob" }, { "$ref": "#/$defs/HeyReachEventPage" }, { "$ref": "#/$defs/HeyReachWebhookList" }, { "$ref": "#/$defs/HeyReachDocument" } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/HeyReachConnectionStatus" }, { "$ref": "#/$defs/HeyReachAccountPage" }, { "$ref": "#/$defs/HeyReachAccount" }, { "$ref": "#/$defs/HeyReachProxyCountryList" }, { "$ref": "#/$defs/HeyReachCampaignPage" }, { "$ref": "#/$defs/HeyReachCampaign" }, { "$ref": "#/$defs/HeyReachDocumentPage" }, { "$ref": "#/$defs/HeyReachListPage" }, { "$ref": "#/$defs/HeyReachList" }, { "$ref": "#/$defs/HeyReachLeadTags" }, { "$ref": "#/$defs/HeyReachConversationPage" }, { "$ref": "#/$defs/HeyReachConversation" }, { "$ref": "#/$defs/HeyReachConnectionCheck" }, { "$ref": "#/$defs/HeyReachStats" }, { "$ref": "#/$defs/HeyReachEnrichmentJob" }, { "$ref": "#/$defs/HeyReachEventPage" }, { "$ref": "#/$defs/HeyReachWebhookList" }, { "$ref": "#/$defs/HeyReachDocument" } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `heyreachConnection.status`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/status` - `heyreachAccounts.list`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/accounts` - `heyreachAccounts.get`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/accounts/:accountId` - `heyreachAccounts.status`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/accounts/:accountId/status` - `heyreachAccounts.proxyCountries`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/accounts/proxy-countries` - `heyreachCampaigns.list`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/search` - `heyreachCampaigns.get`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId` - `heyreachCampaigns.sequence`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/sequence` - `heyreachCampaigns.leads`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/leads` - `heyreachCampaigns.forLead`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/for-lead` - `heyreachLists.list`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/lists/search` - `heyreachLists.get`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/lists/:listId` - `heyreachLists.leads`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/lists/:listId/leads` - `heyreachLeads.lookup`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/leads/lookup` - `heyreachLeads.tags`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/leads/tags` - `heyreachConversations.list`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/conversations/search` - `heyreachConversations.get`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/accounts/:accountId/conversations/:conversationId` - `heyreachInsights.network`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/accounts/:accountId/network` - `heyreachInsights.isConnection`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/network/connection` - `heyreachInsights.stats`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/statistics` - `heyreachInsights.statsByCampaign`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/statistics/by-campaign` - `heyreachInsights.enrichStatus`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/enrichment/:jobId` - `heyreachInsights.events`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/events` - `heyreachWebhooks.list`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/webhooks`