{
  "service": "instantly_ai",
  "displayName": "Instantly.ai",
  "categories": [
    "Marketing"
  ],
  "authTypes": [
    "api_key"
  ],
  "auth": [
    {
      "type": "api_key",
      "label": "API Key",
      "placeholder": "INSTANTLY_API_KEY",
      "description": "Instantly API key sent as a Bearer token. Create or view API keys in Instantly settings: https://app.instantly.ai/app/settings/integrations."
    }
  ],
  "homepageUrl": "https://instantly.ai",
  "actions": [
    {
      "id": "instantly_ai.create_lead",
      "service": "instantly_ai",
      "name": "create_lead",
      "description": "Create a lead in an Instantly campaign or lead list.",
      "requiredScopes": [
        "leads:create"
      ],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "campaign": {
            "anyOf": [
              {
                "type": "string",
                "description": "Campaign ID associated with the lead.",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "list_id": {
            "anyOf": [
              {
                "type": "string",
                "description": "Lead list ID associated with the lead.",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "email": {
            "anyOf": [
              {
                "type": "string",
                "description": "Email address of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "personalization": {
            "anyOf": [
              {
                "type": "string",
                "description": "Personalization text for the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "website": {
            "anyOf": [
              {
                "type": "string",
                "description": "Website of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "last_name": {
            "anyOf": [
              {
                "type": "string",
                "description": "Last name of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "first_name": {
            "anyOf": [
              {
                "type": "string",
                "description": "First name of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "company_name": {
            "anyOf": [
              {
                "type": "string",
                "description": "Company name of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "job_title": {
            "anyOf": [
              {
                "type": "string",
                "description": "Job title of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "phone": {
            "anyOf": [
              {
                "type": "string",
                "description": "Phone number of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "lt_interest_status": {
            "type": "number",
            "description": "Lead interest status enum value."
          },
          "pl_value_lead": {
            "anyOf": [
              {
                "type": "string",
                "description": "Potential value of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "assigned_to": {
            "anyOf": [
              {
                "type": "string",
                "description": "ID of the user assigned to the lead.",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "skip_if_in_workspace": {
            "type": "boolean",
            "description": "Whether to skip creation if the lead is already in the workspace."
          },
          "skip_if_in_campaign": {
            "type": "boolean",
            "description": "Whether to skip creation if the lead is already in the campaign."
          },
          "skip_if_in_list": {
            "type": "boolean",
            "description": "Whether to skip creation if the lead is already in the list."
          },
          "blocklist_id": {
            "type": "string",
            "description": "The blocklist ID to check for the lead.",
            "format": "uuid"
          },
          "verify_leads_for_lead_finder": {
            "type": "boolean",
            "description": "Whether to verify the lead for lead finder."
          },
          "verify_leads_on_import": {
            "type": "boolean",
            "description": "Whether to verify the lead on import."
          },
          "custom_variables": {
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "description": "A string custom variable value."
                },
                {
                  "type": "number",
                  "description": "A numeric custom variable value."
                },
                {
                  "type": "boolean",
                  "description": "A boolean custom variable value."
                },
                {
                  "type": "null",
                  "description": "A null custom variable value."
                }
              ],
              "description": "A supported custom variable value."
            },
            "description": "Custom variables for an Instantly lead. Values must be strings, numbers, booleans, or null."
          }
        },
        "additionalProperties": false,
        "description": "Input parameters for creating an Instantly lead. Provide campaign or list_id. When campaign is provided, email is required. When list_id is provided without email, first_name or last_name is required."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the lead.",
            "format": "uuid"
          },
          "timestamp_created": {
            "type": "string",
            "description": "An ISO 8601 timestamp returned by Instantly.",
            "format": "date-time"
          },
          "timestamp_updated": {
            "type": "string",
            "description": "An ISO 8601 timestamp returned by Instantly.",
            "format": "date-time"
          },
          "organization": {
            "type": "string",
            "description": "Organization ID associated with the lead.",
            "format": "uuid"
          },
          "campaign": {
            "anyOf": [
              {
                "type": "string",
                "description": "Campaign ID associated with the lead.",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "list_id": {
            "anyOf": [
              {
                "type": "string",
                "description": "Lead list ID associated with the lead.",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "type": "number",
            "description": "Lead status enum value returned by Instantly."
          },
          "email": {
            "anyOf": [
              {
                "type": "string",
                "description": "Email address of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "first_name": {
            "anyOf": [
              {
                "type": "string",
                "description": "First name of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "last_name": {
            "anyOf": [
              {
                "type": "string",
                "description": "Last name of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "company_name": {
            "anyOf": [
              {
                "type": "string",
                "description": "Company name of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "job_title": {
            "anyOf": [
              {
                "type": "string",
                "description": "Job title of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "website": {
            "anyOf": [
              {
                "type": "string",
                "description": "Website of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "phone": {
            "anyOf": [
              {
                "type": "string",
                "description": "Phone number of the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "personalization": {
            "anyOf": [
              {
                "type": "string",
                "description": "Personalization text for the lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "email_open_count": {
            "type": "number",
            "description": "Number of times the lead opened campaign emails."
          },
          "email_reply_count": {
            "type": "number",
            "description": "Number of times the lead replied to campaign emails."
          },
          "email_click_count": {
            "type": "number",
            "description": "Number of times the lead clicked campaign links."
          },
          "company_domain": {
            "type": "string",
            "description": "Company domain of the lead."
          },
          "payload": {
            "anyOf": [
              {
                "type": "object",
                "additionalProperties": {
                  "description": "A payload value."
                },
                "description": "Custom variables returned in the lead payload."
              },
              {
                "type": "null"
              }
            ]
          },
          "lt_interest_status": {
            "type": "number",
            "description": "Lead interest status enum value returned by Instantly."
          },
          "verification_status": {
            "type": "number",
            "description": "Lead verification status enum value returned by Instantly."
          },
          "enrichment_status": {
            "type": "number",
            "description": "Lead enrichment status enum value returned by Instantly."
          },
          "assigned_to": {
            "anyOf": [
              {
                "type": "string",
                "description": "ID of the user assigned to the lead.",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": true,
        "required": [
          "id",
          "timestamp_created",
          "timestamp_updated",
          "organization",
          "status",
          "email_open_count",
          "email_reply_count",
          "email_click_count",
          "company_domain"
        ],
        "description": "A lead returned by the Instantly API, with key fields normalized and the remaining upstream fields preserved."
      }
    },
    {
      "id": "instantly_ai.get_campaign",
      "service": "instantly_ai",
      "name": "get_campaign",
      "description": "Retrieve one Instantly campaign by ID.",
      "requiredScopes": [
        "campaigns:read"
      ],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The Instantly campaign ID.",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "description": "Input parameters for retrieving an Instantly campaign."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the campaign.",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "description": "Name of the campaign."
          },
          "status": {
            "type": "number",
            "description": "Campaign status enum value returned by Instantly."
          },
          "timestamp_created": {
            "type": "string",
            "description": "An ISO 8601 timestamp returned by Instantly.",
            "format": "date-time"
          },
          "timestamp_updated": {
            "type": "string",
            "description": "An ISO 8601 timestamp returned by Instantly.",
            "format": "date-time"
          },
          "pl_value": {
            "anyOf": [
              {
                "type": "number",
                "description": "Value of every positive lead."
              },
              {
                "type": "null"
              }
            ]
          },
          "is_evergreen": {
            "anyOf": [
              {
                "type": "boolean",
                "description": "Whether the campaign is evergreen."
              },
              {
                "type": "null"
              }
            ]
          },
          "daily_limit": {
            "anyOf": [
              {
                "type": "number",
                "description": "The campaign daily sending limit."
              },
              {
                "type": "null"
              }
            ]
          },
          "daily_max_leads": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 0,
                "description": "The daily maximum number of new leads to contact."
              },
              {
                "type": "null"
              }
            ]
          },
          "stop_on_reply": {
            "anyOf": [
              {
                "type": "boolean",
                "description": "Whether the campaign stops when a lead replies."
              },
              {
                "type": "null"
              }
            ]
          },
          "open_tracking": {
            "type": "boolean",
            "description": "Whether the campaign tracks email opens."
          },
          "link_tracking": {
            "anyOf": [
              {
                "type": "boolean",
                "description": "Whether the campaign tracks link clicks."
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": true,
        "required": [
          "id",
          "name",
          "status",
          "timestamp_created",
          "timestamp_updated"
        ],
        "description": "A campaign returned by the Instantly API, with key fields normalized and the remaining upstream fields preserved."
      }
    },
    {
      "id": "instantly_ai.list_campaigns",
      "service": "instantly_ai",
      "name": "list_campaigns",
      "description": "List Instantly campaigns with optional search, tag, and status filters.",
      "requiredScopes": [
        "campaigns:read"
      ],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "limit": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100,
            "description": "The number of campaigns to return, from 1 to 100."
          },
          "starting_after": {
            "type": "string",
            "minLength": 1,
            "description": "The pagination cursor returned by Instantly."
          },
          "search": {
            "type": "string",
            "minLength": 1,
            "description": "Search campaigns by name."
          },
          "tag_ids": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "A campaign tag ID.",
              "format": "uuid"
            },
            "description": "Campaign tag IDs to filter by. Instantly receives these as a comma-separated query value.",
            "minItems": 1
          },
          "ai_sales_agent_id": {
            "type": "string",
            "description": "Filter campaigns by AI Sales Agent ID.",
            "format": "uuid"
          },
          "status": {
            "type": "number",
            "description": "Filter campaigns by Instantly campaign status enum value."
          }
        },
        "additionalProperties": false,
        "description": "Input parameters for listing Instantly campaigns."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Unique identifier for the campaign.",
                  "format": "uuid"
                },
                "name": {
                  "type": "string",
                  "description": "Name of the campaign."
                },
                "status": {
                  "type": "number",
                  "description": "Campaign status enum value returned by Instantly."
                },
                "timestamp_created": {
                  "type": "string",
                  "description": "An ISO 8601 timestamp returned by Instantly.",
                  "format": "date-time"
                },
                "timestamp_updated": {
                  "type": "string",
                  "description": "An ISO 8601 timestamp returned by Instantly.",
                  "format": "date-time"
                },
                "pl_value": {
                  "anyOf": [
                    {
                      "type": "number",
                      "description": "Value of every positive lead."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "is_evergreen": {
                  "anyOf": [
                    {
                      "type": "boolean",
                      "description": "Whether the campaign is evergreen."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "daily_limit": {
                  "anyOf": [
                    {
                      "type": "number",
                      "description": "The campaign daily sending limit."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "daily_max_leads": {
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": 0,
                      "description": "The daily maximum number of new leads to contact."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "stop_on_reply": {
                  "anyOf": [
                    {
                      "type": "boolean",
                      "description": "Whether the campaign stops when a lead replies."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "open_tracking": {
                  "type": "boolean",
                  "description": "Whether the campaign tracks email opens."
                },
                "link_tracking": {
                  "anyOf": [
                    {
                      "type": "boolean",
                      "description": "Whether the campaign tracks link clicks."
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "additionalProperties": true,
              "required": [
                "id",
                "name",
                "status",
                "timestamp_created",
                "timestamp_updated"
              ],
              "description": "A campaign returned by the Instantly API, with key fields normalized and the remaining upstream fields preserved."
            },
            "description": "Campaigns returned for the requested page."
          },
          "next_starting_after": {
            "type": "string",
            "minLength": 1,
            "description": "The pagination cursor returned by Instantly."
          }
        },
        "additionalProperties": false,
        "required": [
          "items"
        ],
        "description": "A page of Instantly campaigns."
      }
    },
    {
      "id": "instantly_ai.list_leads",
      "service": "instantly_ai",
      "name": "list_leads",
      "description": "List Instantly leads using JSON filters and cursor pagination.",
      "requiredScopes": [
        "leads:read"
      ],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "search": {
            "type": "string",
            "minLength": 1,
            "description": "Search leads by first name, last name, or email."
          },
          "filter": {
            "type": "string",
            "minLength": 1,
            "description": "Instantly lead filter value, such as FILTER_VAL_CONTACTED."
          },
          "campaign": {
            "type": "string",
            "description": "Campaign ID to filter leads.",
            "format": "uuid"
          },
          "list_id": {
            "type": "string",
            "description": "Lead list ID to filter leads.",
            "format": "uuid"
          },
          "in_campaign": {
            "type": "boolean",
            "description": "Whether to return leads that are in a campaign."
          },
          "in_list": {
            "type": "boolean",
            "description": "Whether to return leads that are in a lead list."
          },
          "ids": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "A lead ID.",
              "format": "uuid"
            },
            "description": "Lead IDs to include.",
            "minItems": 1
          },
          "excluded_ids": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "A lead ID to exclude.",
              "format": "uuid"
            },
            "description": "Lead IDs to exclude.",
            "minItems": 1
          },
          "contacts": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "A lead email address.",
              "format": "email"
            },
            "description": "Lead email addresses to include.",
            "minItems": 1
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100,
            "description": "The number of leads to return, from 1 to 100."
          },
          "starting_after": {
            "type": "string",
            "minLength": 1,
            "description": "The pagination cursor returned by Instantly."
          },
          "organization_user_ids": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "An organization user ID.",
              "format": "uuid"
            },
            "description": "Organization user IDs to filter leads.",
            "minItems": 1
          },
          "smart_view_id": {
            "type": "string",
            "description": "Smart view ID to filter leads.",
            "format": "uuid"
          },
          "is_website_visitor": {
            "type": "boolean",
            "description": "Whether to return website visitor leads."
          },
          "distinct_contacts": {
            "type": "boolean",
            "description": "Whether to return distinct contacts."
          },
          "enrichment_status": {
            "type": "number",
            "description": "Enrichment status enum value to filter leads."
          },
          "esg_code": {
            "type": "string",
            "enum": [
              "0",
              "1",
              "2",
              "3",
              "4",
              "all",
              "none"
            ],
            "description": "ESG code to filter leads."
          }
        },
        "additionalProperties": false,
        "description": "Input parameters for listing Instantly leads."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Unique identifier for the lead.",
                  "format": "uuid"
                },
                "timestamp_created": {
                  "type": "string",
                  "description": "An ISO 8601 timestamp returned by Instantly.",
                  "format": "date-time"
                },
                "timestamp_updated": {
                  "type": "string",
                  "description": "An ISO 8601 timestamp returned by Instantly.",
                  "format": "date-time"
                },
                "organization": {
                  "type": "string",
                  "description": "Organization ID associated with the lead.",
                  "format": "uuid"
                },
                "campaign": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "Campaign ID associated with the lead.",
                      "format": "uuid"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "list_id": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "Lead list ID associated with the lead.",
                      "format": "uuid"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "status": {
                  "type": "number",
                  "description": "Lead status enum value returned by Instantly."
                },
                "email": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "Email address of the lead."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "first_name": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "First name of the lead."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "last_name": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "Last name of the lead."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "company_name": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "Company name of the lead."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "job_title": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "Job title of the lead."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "website": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "Website of the lead."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "phone": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "Phone number of the lead."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "personalization": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "Personalization text for the lead."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "email_open_count": {
                  "type": "number",
                  "description": "Number of times the lead opened campaign emails."
                },
                "email_reply_count": {
                  "type": "number",
                  "description": "Number of times the lead replied to campaign emails."
                },
                "email_click_count": {
                  "type": "number",
                  "description": "Number of times the lead clicked campaign links."
                },
                "company_domain": {
                  "type": "string",
                  "description": "Company domain of the lead."
                },
                "payload": {
                  "anyOf": [
                    {
                      "type": "object",
                      "additionalProperties": {
                        "description": "A payload value."
                      },
                      "description": "Custom variables returned in the lead payload."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "lt_interest_status": {
                  "type": "number",
                  "description": "Lead interest status enum value returned by Instantly."
                },
                "verification_status": {
                  "type": "number",
                  "description": "Lead verification status enum value returned by Instantly."
                },
                "enrichment_status": {
                  "type": "number",
                  "description": "Lead enrichment status enum value returned by Instantly."
                },
                "assigned_to": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "ID of the user assigned to the lead.",
                      "format": "uuid"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "additionalProperties": true,
              "required": [
                "id",
                "timestamp_created",
                "timestamp_updated",
                "organization",
                "status",
                "email_open_count",
                "email_reply_count",
                "email_click_count",
                "company_domain"
              ],
              "description": "A lead returned by the Instantly API, with key fields normalized and the remaining upstream fields preserved."
            },
            "description": "Leads returned for the requested page."
          },
          "next_starting_after": {
            "type": "string",
            "minLength": 1,
            "description": "The pagination cursor returned by Instantly."
          }
        },
        "additionalProperties": false,
        "required": [
          "items"
        ],
        "description": "A page of Instantly leads."
      }
    }
  ]
}