{ "openapi": "3.0.1", "info": { "title": "Instagram Dm Automation", "description": "Automate Instagram messaging with Instagram DM Automation. Send personalized DMs, schedule messages, and manage replies at scale. Ideal for marketing campaigns, engagement, and customer outreach. Fast, reliable, and fully customizable for individual or bulk contacts.", "version": "0.1", "x-build-id": "XGXlCR5g1sGMGWylS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapier~instagram-dm-automation/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapier-instagram-dm-automation", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/scrapier~instagram-dm-automation/runs": { "post": { "operationId": "runs-sync-scrapier-instagram-dm-automation", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/scrapier~instagram-dm-automation/run-sync": { "post": { "operationId": "run-sync-scrapier-instagram-dm-automation", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "startUrls", "message", "sessionId" ], "properties": { "startUrls": { "title": "Instagram URLs, Usernames, Keywords, or Hashtags", "type": "array", "description": "List one or more Instagram profile URLs (e.g., https://www.instagram.com/username), usernames (e.g., username or @username), keywords (e.g., fitness, travel), or hashtags (e.g., #fitness, #travel). Supports bulk input. Keywords and hashtags will be searched on Instagram to find relevant users.", "items": { "type": "string" } }, "message": { "title": "DM Message", "type": "string", "description": "The message text to send to each user.", "default": "Hey! Just wanted to reach out." }, "sessionId": { "title": "Instagram Session ID", "type": "string", "description": "Your Instagram session ID cookie value. Get this from your browser's cookies after logging into Instagram." }, "delayBetweenMessages": { "title": "Delay Between Messages (seconds)", "minimum": 0, "maximum": 3600, "type": "integer", "description": "Delay in seconds between sending messages to different users.", "default": 45 }, "maxUsers": { "title": "Maximum Users", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of users to process. Leave empty or 0 for no limit.", "default": 10 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Choose which proxies to use. By default, starts with no proxy. If Instagram rejects or blocks the request, falls back to datacenter proxy, then residential proxy with 3 retries." }, "sortOrder": { "title": "Sort Order", "enum": [ "none", "alphabetical", "random" ], "type": "string", "description": "Reserved for future use. Sort order for processing users.", "default": "none" }, "maxComments": { "title": "Max Comments", "minimum": 0, "type": "integer", "description": "Reserved for future use. Maximum comments to process.", "default": 0 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }