manage_heyreach_campaigns
Run the workspace's HeyReach LinkedIn campaigns: create one (from scratch or a template), change its settings, schedule, or action sequence, add, replace, or remove its senders, start, pause, or resume it, stop one lead, create a list, remove leads from a list, and set a lead's tags.
# 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)
## manage_heyreach_campaigns
Run the workspace's HeyReach LinkedIn campaigns: create one (from scratch or a template), change its settings, schedule, or action sequence, add, replace, or remove its senders, start, pause, or resume it, stop one lead, create a list, remove leads from a list, and set a lead's tags.
Use to carry out an outreach plan a person has agreed to. Pausing and stopping a lead are always available; starting, resuming, and adding senders put real LinkedIn actions in motion and are refused on a frozen subscription.
HeyReach cannot delete a campaign or a list, so create only what the person asked for — the server deduplicates retries of the same create. Creating campaigns and lists is disabled on preview deployments, which share a real HeyReach account. Tags must already exist in HeyReach; unknown tags are not created.
Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token.
Scopes: integration:update, campaign:create, campaign:update, campaign:launch, campaign:pause
Risk: costly; confirmation: explicit; idempotency: supported.
### 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"
},
"action": {
"type": "string",
"enum": [
"create"
]
},
"create": {
"$ref": "#/$defs/CreateHeyReachCampaignInput"
}
},
"required": [
"workspaceId",
"action",
"create"
],
"patternProperties": {
"^(?!(?:workspaceId|action|create)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"create"
]
}
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"create_from_template"
]
},
"fromTemplate": {
"$ref": "#/$defs/CreateHeyReachCampaignFromTemplateInput"
}
},
"required": [
"workspaceId",
"action",
"fromTemplate"
],
"patternProperties": {
"^(?!(?:workspaceId|action|fromTemplate)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"fromTemplate"
]
}
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"update_settings"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"settings": {
"$ref": "#/$defs/UpdateHeyReachCampaignSettingsInput"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"settings"
],
"patternProperties": {
"^(?!(?:workspaceId|action|campaignId|settings)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"settings"
]
}
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"update_schedule"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"schedule": {
"$ref": "#/$defs/HeyReachCampaignSchedule"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"schedule"
],
"patternProperties": {
"^(?!(?:workspaceId|action|campaignId|schedule)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"schedule"
]
}
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"update_sequence"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"sequence": {
"$ref": "#/$defs/HeyReachCampaignSequence_1"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"sequence"
],
"patternProperties": {
"^(?!(?:workspaceId|action|campaignId|sequence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"sequence"
]
}
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"add_accounts"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"accounts": {
"$ref": "#/$defs/HeyReachCampaignAccountsInput"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"accounts"
],
"patternProperties": {
"^(?!(?:workspaceId|action|campaignId|accounts)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"accounts"
]
}
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"set_accounts"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"accounts": {
"$ref": "#/$defs/HeyReachCampaignAccountsInput"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"accounts"
],
"patternProperties": {
"^(?!(?:workspaceId|action|campaignId|accounts)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"accounts"
]
}
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"remove_accounts"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"accounts": {
"$ref": "#/$defs/HeyReachCampaignAccountsInput"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"accounts"
],
"patternProperties": {
"^(?!(?:workspaceId|action|campaignId|accounts)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"accounts"
]
}
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"pause"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
}
},
"required": [
"workspaceId",
"action",
"campaignId"
],
"patternProperties": {
"^(?!(?:workspaceId|action|campaignId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"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"
},
"action": {
"type": "string",
"enum": [
"resume"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
}
},
"required": [
"workspaceId",
"action",
"campaignId"
],
"patternProperties": {
"^(?!(?:workspaceId|action|campaignId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"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"
},
"action": {
"type": "string",
"enum": [
"start"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
}
},
"required": [
"workspaceId",
"action",
"campaignId"
],
"patternProperties": {
"^(?!(?:workspaceId|action|campaignId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"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"
},
"action": {
"type": "string",
"enum": [
"stop_lead"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"stopLead": {
"$ref": "#/$defs/StopHeyReachLeadInput"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"stopLead"
],
"patternProperties": {
"^(?!(?:workspaceId|action|campaignId|stopLead)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"stopLead"
]
}
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"create_list"
]
},
"list": {
"$ref": "#/$defs/CreateHeyReachListInput"
}
},
"required": [
"workspaceId",
"action",
"list"
],
"patternProperties": {
"^(?!(?:workspaceId|action|list)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"list"
]
}
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"remove_list_leads"
]
},
"listId": {
"$ref": "#/$defs/HeyReachId"
},
"removeLeads": {
"$ref": "#/$defs/RemoveHeyReachListLeadsInput"
}
},
"required": [
"workspaceId",
"action",
"listId",
"removeLeads"
],
"patternProperties": {
"^(?!(?:workspaceId|action|listId|removeLeads)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"listId",
"removeLeads"
]
}
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"add_lead_tags"
]
},
"tags": {
"$ref": "#/$defs/SetHeyReachLeadTagsInput"
}
},
"required": [
"workspaceId",
"action",
"tags"
],
"patternProperties": {
"^(?!(?:workspaceId|action|tags)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"tags"
]
}
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"replace_lead_tags"
]
},
"tags": {
"$ref": "#/$defs/SetHeyReachLeadTagsInput"
}
},
"required": [
"workspaceId",
"action",
"tags"
],
"patternProperties": {
"^(?!(?:workspaceId|action|tags)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"tags"
]
}
}
],
"$defs": {
"HeyReachId": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"HeyReachCampaignSchedule": {
"type": "object",
"properties": {
"dailyStartTime": {
"type": "string",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$|^24:00:00$"
},
"dailyEndTime": {
"type": "string",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$|^24:00:00$"
},
"timeZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"enabledMonday": {
"type": "boolean"
},
"enabledTuesday": {
"type": "boolean"
},
"enabledWednesday": {
"type": "boolean"
},
"enabledThursday": {
"type": "boolean"
},
"enabledFriday": {
"type": "boolean"
},
"enabledSaturday": {
"type": "boolean"
},
"enabledSunday": {
"type": "boolean"
},
"startDate": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
},
"endDate": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
}
},
"required": [
"dailyStartTime",
"dailyEndTime",
"timeZoneId"
],
"patternProperties": {
"^(?!(?:dailyStartTime|dailyEndTime|timeZoneId|enabledMonday|enabledTuesday|enabledWednesday|enabledThursday|enabledFriday|enabledSaturday|enabledSunday|startDate|endDate)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dailyStartTime",
"dailyEndTime",
"timeZoneId",
"enabledMonday",
"enabledTuesday",
"enabledWednesday",
"enabledThursday",
"enabledFriday",
"enabledSaturday",
"enabledSunday",
"startDate",
"endDate"
]
}
},
"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_"
}
},
"HeyReachSequenceNode": {
"type": "object",
"properties": {
"nodeType": {
"type": "string",
"enum": [
"CONNECTION_REQUEST",
"MESSAGE",
"INMAIL",
"VIEW_PROFILE",
"FOLLOW",
"LIKE_POST",
"FIND_EMAIL",
"CHECK_IS_CONNECTION",
"CHECK_IS_OPEN_PROFILE",
"SEND_LEAD_TO_INSTANTLY",
"SEND_LEAD_TO_SMARTLEAD",
"SEND_LEAD_TO_BISON",
"END"
]
},
"actionDelay": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"actionDelayUnit": {
"type": "string",
"enum": [
"HOUR",
"DAY"
]
},
"externalReference": {
"type": "string",
"minLength": 0,
"maxLength": 100
},
"payload": {
"$ref": "#/$defs/HeyReachDocument"
},
"unconditionalNode": {
"$ref": "#/$defs/Suspend_"
},
"conditionalNode": {
"$ref": "#/$defs/HeyReachSequenceNode"
}
},
"required": [
"nodeType"
],
"patternProperties": {
"^(?!(?:nodeType|actionDelay|actionDelayUnit|externalReference|payload|unconditionalNode|conditionalNode)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"nodeType",
"actionDelay",
"actionDelayUnit",
"externalReference",
"payload",
"unconditionalNode",
"conditionalNode"
]
}
},
"Suspend_": {
"$ref": "#/$defs/HeyReachSequenceNode"
},
"HeyReachCampaignSequence": {
"type": "object",
"properties": {
"nodeType": {
"type": "string",
"enum": [
"CONNECTION_REQUEST",
"MESSAGE",
"INMAIL",
"VIEW_PROFILE",
"FOLLOW",
"LIKE_POST",
"FIND_EMAIL",
"CHECK_IS_CONNECTION",
"CHECK_IS_OPEN_PROFILE",
"SEND_LEAD_TO_INSTANTLY",
"SEND_LEAD_TO_SMARTLEAD",
"SEND_LEAD_TO_BISON",
"END"
]
},
"actionDelay": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"actionDelayUnit": {
"type": "string",
"enum": [
"HOUR",
"DAY"
]
},
"externalReference": {
"type": "string",
"minLength": 0,
"maxLength": 100
},
"payload": {
"$ref": "#/$defs/HeyReachDocument"
},
"unconditionalNode": {
"$ref": "#/$defs/Suspend_"
},
"conditionalNode": {
"$ref": "#/$defs/HeyReachSequenceNode"
}
},
"required": [
"nodeType"
],
"patternProperties": {
"^(?!(?:nodeType|actionDelay|actionDelayUnit|externalReference|payload|unconditionalNode|conditionalNode)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"nodeType",
"actionDelay",
"actionDelayUnit",
"externalReference",
"payload",
"unconditionalNode",
"conditionalNode"
]
}
},
"CreateHeyReachCampaignInput": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"linkedInUserListId": {
"$ref": "#/$defs/HeyReachId"
},
"linkedInAccountIds": {
"type": "array",
"items": {
"$ref": "#/$defs/HeyReachId"
},
"minItems": 1,
"maxItems": 100
},
"excludeContactedFromOtherCampaigns": {
"type": "boolean"
},
"excludeHasOtherAccConversations": {
"type": "boolean"
},
"excludeContactedFromSenderInOtherCampaign": {
"type": "boolean"
},
"excludeListId": {
"anyOf": [
{
"$ref": "#/$defs/HeyReachId"
},
{
"type": "null"
}
]
},
"schedule": {
"$ref": "#/$defs/HeyReachCampaignSchedule"
},
"sequence": {
"$ref": "#/$defs/HeyReachCampaignSequence"
}
},
"required": [
"name",
"linkedInUserListId",
"linkedInAccountIds"
],
"patternProperties": {
"^(?!(?:name|linkedInUserListId|linkedInAccountIds|excludeContactedFromOtherCampaigns|excludeHasOtherAccConversations|excludeContactedFromSenderInOtherCampaign|excludeListId|schedule|sequence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"linkedInUserListId",
"linkedInAccountIds",
"excludeContactedFromOtherCampaigns",
"excludeHasOtherAccConversations",
"excludeContactedFromSenderInOtherCampaign",
"excludeListId",
"schedule",
"sequence"
]
}
},
"CreateHeyReachCampaignFromTemplateInput": {
"type": "object",
"properties": {
"campaignIdForTemplate": {
"$ref": "#/$defs/HeyReachId"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"linkedInUserListId": {
"$ref": "#/$defs/HeyReachId"
},
"linkedInAccountIds": {
"type": "array",
"items": {
"$ref": "#/$defs/HeyReachId"
},
"minItems": 1,
"maxItems": 100
},
"excludeContactedFromOtherCampaigns": {
"type": "boolean"
},
"excludeHasOtherAccConversations": {
"type": "boolean"
},
"excludeContactedFromSenderInOtherCampaign": {
"type": "boolean"
},
"excludeListId": {
"anyOf": [
{
"$ref": "#/$defs/HeyReachId"
},
{
"type": "null"
}
]
}
},
"required": [
"campaignIdForTemplate",
"name",
"linkedInUserListId",
"linkedInAccountIds",
"excludeContactedFromOtherCampaigns",
"excludeHasOtherAccConversations",
"excludeContactedFromSenderInOtherCampaign"
],
"patternProperties": {
"^(?!(?:campaignIdForTemplate|name|linkedInUserListId|linkedInAccountIds|excludeContactedFromOtherCampaigns|excludeHasOtherAccConversations|excludeContactedFromSenderInOtherCampaign|excludeListId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignIdForTemplate",
"name",
"linkedInUserListId",
"linkedInAccountIds",
"excludeContactedFromOtherCampaigns",
"excludeHasOtherAccConversations",
"excludeContactedFromSenderInOtherCampaign",
"excludeListId"
]
}
},
"UpdateHeyReachCampaignSettingsInput": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"linkedInUserListId": {
"$ref": "#/$defs/HeyReachId"
},
"excludeContactedFromOtherCampaigns": {
"type": "boolean"
},
"excludeHasOtherAccConversations": {
"type": "boolean"
},
"excludeContactedFromSenderInOtherCampaign": {
"type": "boolean"
},
"excludeListId": {
"anyOf": [
{
"$ref": "#/$defs/HeyReachId"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"linkedInUserListId",
"excludeContactedFromOtherCampaigns",
"excludeHasOtherAccConversations",
"excludeContactedFromSenderInOtherCampaign",
"excludeListId"
],
"patternProperties": {
"^(?!(?:name|linkedInUserListId|excludeContactedFromOtherCampaigns|excludeHasOtherAccConversations|excludeContactedFromSenderInOtherCampaign|excludeListId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"linkedInUserListId",
"excludeContactedFromOtherCampaigns",
"excludeHasOtherAccConversations",
"excludeContactedFromSenderInOtherCampaign",
"excludeListId"
]
}
},
"HeyReachCampaignSequence_1": {
"type": "object",
"properties": {
"nodeType": {
"type": "string",
"enum": [
"CONNECTION_REQUEST",
"MESSAGE",
"INMAIL",
"VIEW_PROFILE",
"FOLLOW",
"LIKE_POST",
"FIND_EMAIL",
"CHECK_IS_CONNECTION",
"CHECK_IS_OPEN_PROFILE",
"SEND_LEAD_TO_INSTANTLY",
"SEND_LEAD_TO_SMARTLEAD",
"SEND_LEAD_TO_BISON",
"END"
]
},
"actionDelay": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"actionDelayUnit": {
"type": "string",
"enum": [
"HOUR",
"DAY"
]
},
"externalReference": {
"type": "string",
"minLength": 0,
"maxLength": 100
},
"payload": {
"$ref": "#/$defs/HeyReachDocument"
},
"unconditionalNode": {
"$ref": "#/$defs/Suspend_"
},
"conditionalNode": {
"$ref": "#/$defs/HeyReachSequenceNode"
}
},
"required": [
"nodeType"
],
"patternProperties": {
"^(?!(?:nodeType|actionDelay|actionDelayUnit|externalReference|payload|unconditionalNode|conditionalNode)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"nodeType",
"actionDelay",
"actionDelayUnit",
"externalReference",
"payload",
"unconditionalNode",
"conditionalNode"
]
}
},
"HeyReachCampaignAccountsInput": {
"type": "object",
"properties": {
"linkedInAccountIds": {
"type": "array",
"items": {
"$ref": "#/$defs/HeyReachId"
},
"minItems": 1,
"maxItems": 100
}
},
"required": [
"linkedInAccountIds"
],
"patternProperties": {
"^(?!(?:linkedInAccountIds)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"linkedInAccountIds"
]
}
]
}
},
"LinkedInProfileUrl": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"StopHeyReachLeadInput": {
"type": "object",
"properties": {
"leadUrl": {
"$ref": "#/$defs/LinkedInProfileUrl"
},
"leadMemberId": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"leadUrl"
],
"patternProperties": {
"^(?!(?:leadUrl|leadMemberId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"leadUrl",
"leadMemberId"
]
}
},
"HeyReachListType": {
"type": "string",
"enum": [
"USER_LIST",
"COMPANY_LIST"
]
},
"CreateHeyReachListInput": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"type": {
"$ref": "#/$defs/HeyReachListType"
}
},
"required": [
"name"
],
"patternProperties": {
"^(?!(?:name|type)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type"
]
}
},
"RemoveHeyReachListLeadsInput": {
"type": "object",
"properties": {
"profileUrls": {
"type": "array",
"items": {
"$ref": "#/$defs/LinkedInProfileUrl"
},
"minItems": 1,
"maxItems": 100
}
},
"required": [
"profileUrls"
],
"patternProperties": {
"^(?!(?:profileUrls)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"profileUrls"
]
}
]
}
},
"SetHeyReachLeadTagsInput": {
"type": "object",
"properties": {
"profileUrl": {
"$ref": "#/$defs/LinkedInProfileUrl"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 100
}
},
"required": [
"profileUrl",
"tags"
],
"patternProperties": {
"^(?!(?:profileUrl|tags)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"profileUrl",
"tags"
]
}
}
}
}
```
### 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"
},
"action": {
"type": "string",
"enum": [
"create"
]
},
"create": {
"$ref": "#/$defs/CreateHeyReachCampaignInput"
}
},
"required": [
"workspaceId",
"action",
"create"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|create)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"create"
]
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"create_from_template"
]
},
"fromTemplate": {
"$ref": "#/$defs/CreateHeyReachCampaignFromTemplateInput"
}
},
"required": [
"workspaceId",
"action",
"fromTemplate"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|fromTemplate)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"fromTemplate"
]
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"update_settings"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"settings": {
"$ref": "#/$defs/UpdateHeyReachCampaignSettingsInput"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"settings"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|settings)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"settings"
]
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"update_schedule"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"schedule": {
"$ref": "#/$defs/HeyReachCampaignSchedule"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"schedule"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|schedule)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"schedule"
]
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"update_sequence"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"sequence": {
"$ref": "#/$defs/HeyReachCampaignSequence_1"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"sequence"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|sequence)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"sequence"
]
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"add_accounts"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"accounts": {
"$ref": "#/$defs/HeyReachCampaignAccountsInput"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"accounts"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|accounts)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"accounts"
]
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"set_accounts"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"accounts": {
"$ref": "#/$defs/HeyReachCampaignAccountsInput"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"accounts"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|accounts)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"accounts"
]
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"remove_accounts"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"accounts": {
"$ref": "#/$defs/HeyReachCampaignAccountsInput"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"accounts"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|accounts)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"accounts"
]
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"pause"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
}
},
"required": [
"workspaceId",
"action",
"campaignId"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"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"
},
"action": {
"type": "string",
"enum": [
"resume"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
}
},
"required": [
"workspaceId",
"action",
"campaignId"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"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"
},
"action": {
"type": "string",
"enum": [
"start"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
}
},
"required": [
"workspaceId",
"action",
"campaignId"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"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"
},
"action": {
"type": "string",
"enum": [
"stop_lead"
]
},
"campaignId": {
"$ref": "#/$defs/HeyReachId"
},
"stopLead": {
"$ref": "#/$defs/StopHeyReachLeadInput"
}
},
"required": [
"workspaceId",
"action",
"campaignId",
"stopLead"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|stopLead)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"campaignId",
"stopLead"
]
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"create_list"
]
},
"list": {
"$ref": "#/$defs/CreateHeyReachListInput"
}
},
"required": [
"workspaceId",
"action",
"list"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|list)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"list"
]
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"remove_list_leads"
]
},
"listId": {
"$ref": "#/$defs/HeyReachId"
},
"removeLeads": {
"$ref": "#/$defs/RemoveHeyReachListLeadsInput"
}
},
"required": [
"workspaceId",
"action",
"listId",
"removeLeads"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|listId|removeLeads)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"listId",
"removeLeads"
]
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"add_lead_tags"
]
},
"tags": {
"$ref": "#/$defs/SetHeyReachLeadTagsInput"
}
},
"required": [
"workspaceId",
"action",
"tags"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|tags)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"tags"
]
},
{
"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"
},
"action": {
"type": "string",
"enum": [
"replace_lead_tags"
]
},
"tags": {
"$ref": "#/$defs/SetHeyReachLeadTagsInput"
}
},
"required": [
"workspaceId",
"action",
"tags"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|tags)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"tags"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
}
],
"$defs": {
"HeyReachId": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"HeyReachCampaignSchedule": {
"type": "object",
"properties": {
"dailyStartTime": {
"type": "string",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$|^24:00:00$"
},
"dailyEndTime": {
"type": "string",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$|^24:00:00$"
},
"timeZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"enabledMonday": {
"type": "boolean"
},
"enabledTuesday": {
"type": "boolean"
},
"enabledWednesday": {
"type": "boolean"
},
"enabledThursday": {
"type": "boolean"
},
"enabledFriday": {
"type": "boolean"
},
"enabledSaturday": {
"type": "boolean"
},
"enabledSunday": {
"type": "boolean"
},
"startDate": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
},
"endDate": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
}
},
"required": [
"dailyStartTime",
"dailyEndTime",
"timeZoneId"
],
"patternProperties": {
"^(?!(?:dailyStartTime|dailyEndTime|timeZoneId|enabledMonday|enabledTuesday|enabledWednesday|enabledThursday|enabledFriday|enabledSaturday|enabledSunday|startDate|endDate)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dailyStartTime",
"dailyEndTime",
"timeZoneId",
"enabledMonday",
"enabledTuesday",
"enabledWednesday",
"enabledThursday",
"enabledFriday",
"enabledSaturday",
"enabledSunday",
"startDate",
"endDate"
]
}
},
"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_"
}
},
"HeyReachSequenceNode": {
"type": "object",
"properties": {
"nodeType": {
"type": "string",
"enum": [
"CONNECTION_REQUEST",
"MESSAGE",
"INMAIL",
"VIEW_PROFILE",
"FOLLOW",
"LIKE_POST",
"FIND_EMAIL",
"CHECK_IS_CONNECTION",
"CHECK_IS_OPEN_PROFILE",
"SEND_LEAD_TO_INSTANTLY",
"SEND_LEAD_TO_SMARTLEAD",
"SEND_LEAD_TO_BISON",
"END"
]
},
"actionDelay": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"actionDelayUnit": {
"type": "string",
"enum": [
"HOUR",
"DAY"
]
},
"externalReference": {
"type": "string",
"minLength": 0,
"maxLength": 100
},
"payload": {
"$ref": "#/$defs/HeyReachDocument"
},
"unconditionalNode": {
"$ref": "#/$defs/Suspend_"
},
"conditionalNode": {
"$ref": "#/$defs/HeyReachSequenceNode"
}
},
"required": [
"nodeType"
],
"patternProperties": {
"^(?!(?:nodeType|actionDelay|actionDelayUnit|externalReference|payload|unconditionalNode|conditionalNode)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"nodeType",
"actionDelay",
"actionDelayUnit",
"externalReference",
"payload",
"unconditionalNode",
"conditionalNode"
]
}
},
"Suspend_": {
"$ref": "#/$defs/HeyReachSequenceNode"
},
"HeyReachCampaignSequence": {
"type": "object",
"properties": {
"nodeType": {
"type": "string",
"enum": [
"CONNECTION_REQUEST",
"MESSAGE",
"INMAIL",
"VIEW_PROFILE",
"FOLLOW",
"LIKE_POST",
"FIND_EMAIL",
"CHECK_IS_CONNECTION",
"CHECK_IS_OPEN_PROFILE",
"SEND_LEAD_TO_INSTANTLY",
"SEND_LEAD_TO_SMARTLEAD",
"SEND_LEAD_TO_BISON",
"END"
]
},
"actionDelay": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"actionDelayUnit": {
"type": "string",
"enum": [
"HOUR",
"DAY"
]
},
"externalReference": {
"type": "string",
"minLength": 0,
"maxLength": 100
},
"payload": {
"$ref": "#/$defs/HeyReachDocument"
},
"unconditionalNode": {
"$ref": "#/$defs/Suspend_"
},
"conditionalNode": {
"$ref": "#/$defs/HeyReachSequenceNode"
}
},
"required": [
"nodeType"
],
"patternProperties": {
"^(?!(?:nodeType|actionDelay|actionDelayUnit|externalReference|payload|unconditionalNode|conditionalNode)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"nodeType",
"actionDelay",
"actionDelayUnit",
"externalReference",
"payload",
"unconditionalNode",
"conditionalNode"
]
}
},
"CreateHeyReachCampaignInput": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"linkedInUserListId": {
"$ref": "#/$defs/HeyReachId"
},
"linkedInAccountIds": {
"type": "array",
"items": {
"$ref": "#/$defs/HeyReachId"
},
"minItems": 1,
"maxItems": 100
},
"excludeContactedFromOtherCampaigns": {
"type": "boolean"
},
"excludeHasOtherAccConversations": {
"type": "boolean"
},
"excludeContactedFromSenderInOtherCampaign": {
"type": "boolean"
},
"excludeListId": {
"anyOf": [
{
"$ref": "#/$defs/HeyReachId"
},
{
"type": "null"
}
]
},
"schedule": {
"$ref": "#/$defs/HeyReachCampaignSchedule"
},
"sequence": {
"$ref": "#/$defs/HeyReachCampaignSequence"
}
},
"required": [
"name",
"linkedInUserListId",
"linkedInAccountIds"
],
"patternProperties": {
"^(?!(?:name|linkedInUserListId|linkedInAccountIds|excludeContactedFromOtherCampaigns|excludeHasOtherAccConversations|excludeContactedFromSenderInOtherCampaign|excludeListId|schedule|sequence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"linkedInUserListId",
"linkedInAccountIds",
"excludeContactedFromOtherCampaigns",
"excludeHasOtherAccConversations",
"excludeContactedFromSenderInOtherCampaign",
"excludeListId",
"schedule",
"sequence"
]
}
},
"CreateHeyReachCampaignFromTemplateInput": {
"type": "object",
"properties": {
"campaignIdForTemplate": {
"$ref": "#/$defs/HeyReachId"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"linkedInUserListId": {
"$ref": "#/$defs/HeyReachId"
},
"linkedInAccountIds": {
"type": "array",
"items": {
"$ref": "#/$defs/HeyReachId"
},
"minItems": 1,
"maxItems": 100
},
"excludeContactedFromOtherCampaigns": {
"type": "boolean"
},
"excludeHasOtherAccConversations": {
"type": "boolean"
},
"excludeContactedFromSenderInOtherCampaign": {
"type": "boolean"
},
"excludeListId": {
"anyOf": [
{
"$ref": "#/$defs/HeyReachId"
},
{
"type": "null"
}
]
}
},
"required": [
"campaignIdForTemplate",
"name",
"linkedInUserListId",
"linkedInAccountIds",
"excludeContactedFromOtherCampaigns",
"excludeHasOtherAccConversations",
"excludeContactedFromSenderInOtherCampaign"
],
"patternProperties": {
"^(?!(?:campaignIdForTemplate|name|linkedInUserListId|linkedInAccountIds|excludeContactedFromOtherCampaigns|excludeHasOtherAccConversations|excludeContactedFromSenderInOtherCampaign|excludeListId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignIdForTemplate",
"name",
"linkedInUserListId",
"linkedInAccountIds",
"excludeContactedFromOtherCampaigns",
"excludeHasOtherAccConversations",
"excludeContactedFromSenderInOtherCampaign",
"excludeListId"
]
}
},
"UpdateHeyReachCampaignSettingsInput": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"linkedInUserListId": {
"$ref": "#/$defs/HeyReachId"
},
"excludeContactedFromOtherCampaigns": {
"type": "boolean"
},
"excludeHasOtherAccConversations": {
"type": "boolean"
},
"excludeContactedFromSenderInOtherCampaign": {
"type": "boolean"
},
"excludeListId": {
"anyOf": [
{
"$ref": "#/$defs/HeyReachId"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"linkedInUserListId",
"excludeContactedFromOtherCampaigns",
"excludeHasOtherAccConversations",
"excludeContactedFromSenderInOtherCampaign",
"excludeListId"
],
"patternProperties": {
"^(?!(?:name|linkedInUserListId|excludeContactedFromOtherCampaigns|excludeHasOtherAccConversations|excludeContactedFromSenderInOtherCampaign|excludeListId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"linkedInUserListId",
"excludeContactedFromOtherCampaigns",
"excludeHasOtherAccConversations",
"excludeContactedFromSenderInOtherCampaign",
"excludeListId"
]
}
},
"HeyReachCampaignSequence_1": {
"type": "object",
"properties": {
"nodeType": {
"type": "string",
"enum": [
"CONNECTION_REQUEST",
"MESSAGE",
"INMAIL",
"VIEW_PROFILE",
"FOLLOW",
"LIKE_POST",
"FIND_EMAIL",
"CHECK_IS_CONNECTION",
"CHECK_IS_OPEN_PROFILE",
"SEND_LEAD_TO_INSTANTLY",
"SEND_LEAD_TO_SMARTLEAD",
"SEND_LEAD_TO_BISON",
"END"
]
},
"actionDelay": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"actionDelayUnit": {
"type": "string",
"enum": [
"HOUR",
"DAY"
]
},
"externalReference": {
"type": "string",
"minLength": 0,
"maxLength": 100
},
"payload": {
"$ref": "#/$defs/HeyReachDocument"
},
"unconditionalNode": {
"$ref": "#/$defs/Suspend_"
},
"conditionalNode": {
"$ref": "#/$defs/HeyReachSequenceNode"
}
},
"required": [
"nodeType"
],
"patternProperties": {
"^(?!(?:nodeType|actionDelay|actionDelayUnit|externalReference|payload|unconditionalNode|conditionalNode)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"nodeType",
"actionDelay",
"actionDelayUnit",
"externalReference",
"payload",
"unconditionalNode",
"conditionalNode"
]
}
},
"HeyReachCampaignAccountsInput": {
"type": "object",
"properties": {
"linkedInAccountIds": {
"type": "array",
"items": {
"$ref": "#/$defs/HeyReachId"
},
"minItems": 1,
"maxItems": 100
}
},
"required": [
"linkedInAccountIds"
],
"patternProperties": {
"^(?!(?:linkedInAccountIds)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"linkedInAccountIds"
]
}
]
}
},
"LinkedInProfileUrl": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"StopHeyReachLeadInput": {
"type": "object",
"properties": {
"leadUrl": {
"$ref": "#/$defs/LinkedInProfileUrl"
},
"leadMemberId": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"leadUrl"
],
"patternProperties": {
"^(?!(?:leadUrl|leadMemberId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"leadUrl",
"leadMemberId"
]
}
},
"HeyReachListType": {
"type": "string",
"enum": [
"USER_LIST",
"COMPANY_LIST"
]
},
"CreateHeyReachListInput": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"type": {
"$ref": "#/$defs/HeyReachListType"
}
},
"required": [
"name"
],
"patternProperties": {
"^(?!(?:name|type)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type"
]
}
},
"RemoveHeyReachListLeadsInput": {
"type": "object",
"properties": {
"profileUrls": {
"type": "array",
"items": {
"$ref": "#/$defs/LinkedInProfileUrl"
},
"minItems": 1,
"maxItems": 100
}
},
"required": [
"profileUrls"
],
"patternProperties": {
"^(?!(?:profileUrls)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"profileUrls"
]
}
]
}
},
"SetHeyReachLeadTagsInput": {
"type": "object",
"properties": {
"profileUrl": {
"$ref": "#/$defs/LinkedInProfileUrl"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 100
}
},
"required": [
"profileUrl",
"tags"
],
"patternProperties": {
"^(?!(?:profileUrl|tags)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"profileUrl",
"tags"
]
}
}
}
}
```
### Output schema (structuredContent)
```json
{
"$defs": {
"HeyReachId": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"HeyReachCampaignCreated": {
"type": "object",
"properties": {
"campaignId": {
"$ref": "#/$defs/HeyReachId"
}
},
"required": [
"campaignId"
],
"patternProperties": {
"^(?!(?:campaignId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"campaignId"
]
}
]
}
},
"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_"
}
},
"HeyReachText": {
"type": "string",
"minLength": 0,
"maxLength": 10000
},
"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"
]
}
}
},
"type": "object",
"anyOf": [
{
"allOf": [
{
"anyOf": [
{
"$ref": "#/$defs/HeyReachCampaignCreated"
},
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"success"
],
"patternProperties": {
"^(?!(?:success)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"success"
]
}
]
}
},
{
"$ref": "#/$defs/HeyReachDocument"
},
{
"$ref": "#/$defs/HeyReachList"
}
]
},
{
"type": "object"
}
]
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"anyOf": [
{
"$ref": "#/$defs/HeyReachCampaignCreated"
},
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"success"
],
"patternProperties": {
"^(?!(?:success)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"success"
]
}
]
}
},
{
"$ref": "#/$defs/HeyReachDocument"
},
{
"$ref": "#/$defs/HeyReachList"
}
]
},
{
"not": {
"type": "object"
}
}
]
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
```
### Underlying API operations
- `heyreachCampaigns.create`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns`
- `heyreachCampaigns.createFromTemplate`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/from-template`
- `heyreachCampaigns.updateSettings`: `PUT /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/settings`
- `heyreachCampaigns.updateSchedule`: `PUT /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/schedule`
- `heyreachCampaigns.updateSequence`: `PUT /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/sequence`
- `heyreachCampaigns.addAccounts`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/accounts`
- `heyreachCampaigns.setAccounts`: `PUT /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/accounts`
- `heyreachCampaigns.removeAccounts`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/accounts/remove`
- `heyreachCampaigns.pause`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/pause`
- `heyreachCampaigns.resume`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/resume`
- `heyreachCampaigns.start`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/start`
- `heyreachCampaigns.stopLead`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/leads/stop`
- `heyreachLists.create`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/lists`
- `heyreachLists.deleteLeads`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/lists/:listId/leads/remove`
- `heyreachLeads.addTags`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/leads/tags`
- `heyreachLeads.replaceTags`: `PUT /v1/workspaces/:workspaceId/integrations/heyreach/leads/tags`