Knowledge Base

API Reference Documentation for Sending a dataset using The Facebook Connector

Below is the reference documentation for sending (or syncing) a dataset to Facebook via Narrative’s Connections endpoint. For more information on the Narrative API, visit api.narrative.io.

Endpoint


POST <https://app.narrative.io/connections>

Request Body

{
    "dataset_id": 1234,
    "profile_id": "dfd74...",
    "quick_settings": {
        "type": "audience_new",
        "audience_name": "my audience name",
        "historical_data_enabled": true
    }
}

dataset_id: The numeric identifier of your dataset in Narrative.
profile_id: The Facebook Connector profile ID you created (truncated for illustration).
quick_settings:
- type: Defines the type of audience (e.g., audience_new).
- audience_name: Human-friendly name for your Facebook Custom Audience.
- historical_data_enabled: true includes matching historical records in your new audience.

Response

Status Code: 201 Created

{
    "id": "dfd74...",
    "dataset_id": 1234,
    "quick_settings": {
        "type": "audience_new",
        "audience_name": "my audience name",
        "historical_data_enabled": true
    },
    "profile_id": "9b616...",
    "status": "active"
}