{ "openapi": "3.0.1", "info": { "title": "Facebook Custom Audiences, Lookalikes & Hash PII Automatically", "description": "Create & manage Facebook Custom Audiences via Meta Marketing API. Add/remove users w/SHA256 hashing, create lookalike audiences share & audience insights.\nCreate a new custom audience\nGet details of specific audience\nList all custom audiences\nUpdate audience name/description\nDelete a custom audience", "version": "1.0", "x-build-id": "kUJfVX3czpes0dfEK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~facebook-custom-audiences-lookalikes-hash-pii-automatically/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-facebook-custom-audiences-lookalikes-hash-pii-automatically", "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/alizarin_refrigerator-owner~facebook-custom-audiences-lookalikes-hash-pii-automatically/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-facebook-custom-audiences-lookalikes-hash-pii-automatically", "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/alizarin_refrigerator-owner~facebook-custom-audiences-lookalikes-hash-pii-automatically/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-facebook-custom-audiences-lookalikes-hash-pii-automatically", "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": [ "task" ], "properties": { "task": { "title": "Task", "enum": [ "create_audience", "get_audience", "list_audiences", "update_audience", "delete_audience", "add_users", "remove_users", "get_audience_users", "create_lookalike", "share_audience", "get_audience_insights" ], "type": "string", "description": "The operation to perform", "default": "list_audiences" }, "accessToken": { "title": "Facebook Access Token", "type": "string", "description": "Facebook Marketing API access token with ads_management permission" }, "adAccountId": { "title": "Ad Account ID", "type": "string", "description": "Facebook Ad Account ID (format: act_123456789)" }, "audienceId": { "title": "Custom Audience ID", "type": "string", "description": "ID of the custom audience to operate on" }, "audienceName": { "title": "Audience Name", "type": "string", "description": "Name for the custom audience" }, "audienceDescription": { "title": "Audience Description", "type": "string", "description": "Description for the custom audience" }, "optOutLink": { "title": "Opt-Out Link", "type": "string", "description": "URL where users can opt out of targeting" }, "customerFileSource": { "title": "Customer File Source", "enum": [ "USER_PROVIDED_ONLY", "PARTNER_PROVIDED_ONLY", "BOTH_USER_AND_PARTNER_PROVIDED" ], "type": "string", "description": "Source of customer data for compliance", "default": "USER_PROVIDED_ONLY" }, "users": { "title": "Users (JSON Array)", "type": "string", "description": "JSON array of user objects with email, phone, firstName, lastName, city, state, country, zip fields" }, "schema": { "title": "Data Schema", "type": "string", "description": "Schema of user data being uploaded (comma-separated: EMAIL,PHONE,FN,LN,CT,ST,COUNTRY,ZIP)", "default": "EMAIL,PHONE,FN,LN" }, "isAlreadyHashed": { "title": "Data Already Hashed", "type": "boolean", "description": "Set to true if user data is already SHA256 hashed", "default": false }, "lookalikeSpec": { "title": "Lookalike Specification (JSON)", "type": "string", "description": "JSON object with origin_audience_id, starting_ratio, ratio, and country" }, "targetAdAccountId": { "title": "Target Ad Account ID", "type": "string", "description": "Ad account ID to share audience with (for share_audience task)" }, "retentionDays": { "title": "Retention Days", "minimum": 1, "maximum": 365, "type": "integer", "description": "Number of days to retain audience members", "default": 180 }, "webhookUrl": { "title": "Result Webhook URL", "type": "string", "description": "URL to receive results via webhook" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data for testing (no external API calls)", "default": true } } }, "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 } } } } } } } } } }