> ## Documentation Index
> Fetch the complete documentation index at: https://docs.narrative.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Delivering Customer Lists to Snapchat via the API

> Upload hashed identifiers to Narrative and deliver them into a new Snapchat customer list over the API

This guide shows you how to build an unattended integration that uploads an audience to Narrative and delivers it into a new customer list in one Snapchat ad account. Snapchat calls these lists Snap Audience Match audiences.

Before you start, complete the [prerequisites](/guides/connector-apis/snapchat#prerequisites) and [set up API access](/guides/connector-apis/snapchat#set-up-api-access). You need a profile ID and an ad account ID from [List your advertisers](/guides/connector-apis/snapchat#list-your-advertisers).

## 1. Create the dataset

The dataset must carry at least one identifier column that Snapchat can match on. [Required columns](#required-columns) lists them.

```bash theme={null}
curl -X POST https://api.narrative.io/datasets \
  -H "Authorization: Bearer $NIO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "spring_buyers_snapchat",
    "display_name": "Spring Buyers (Snapchat)",
    "description": "Hashed emails for Snapchat",
    "write_mode": "append",
    "schema": {
      "file_config": { "type": "json", "normalize_field_names": false },
      "type": "object",
      "properties": {
        "sha256_hashed_email": {
          "type": "object",
          "properties": { "value": { "type": "string" } }
        }
      }
    }
  }'
# → {"id": 12345, "status": "pending", ...}
```

Record the `id` in the response.

### Required columns

The dataset needs at least one of these identifier columns:

| Column | Shape of each value |
| - | - |
| `hashed_email` | `{"value": ..., "type": "..."}` |
| `raw_email` | A string |
| `sha256_hashed_email` | `{"value": ...}` |
| `e164_phone_number` | A string |
| `telephone_number` | A string |
| `sha256_hashed_phone_number` | `{"value": ...}` |
| `maid` | A string |
| `mobile_id_unique_identifier` | `{"value": ..., "type": "..."}` |
| `apple_idfa` | `{"value": ...}` |
| `android_advertising_id` | `{"value": ...}` |
| `narrative_id` | `{"context": "...", "value": ...}` |
| `unique_id` | `{"value": ..., "type": "..."}` |

Each identifier column is named after its Rosetta Stone attribute, and the connector matches on that column name. A column holds either a plain string or an object. In the dataset schema, declare a string column with `"type": "string"`, and declare an object column with `"type": "object"` and its properties:

```json theme={null}
{
  "type": "object",
  "properties": {
    "<string_attribute>": { "type": "string" },
    "<object_attribute>": {
      "type": "object",
      "properties": { "<property>": { "type": "<type>" } }
    }
  }
}
```

Send an object column as an object in each row:

```json theme={null}
{"<string_attribute>": "...", "<object_attribute>": {"<property>": "..."}}
```

See your connector's reference page for the attributes it accepts and their exact shapes.

A row with one identifier looks like this:

```json theme={null}
{"sha256_hashed_email": {"value": "<SHA-256 of the trimmed, lowercased email>"}}
```

See [Supported identifiers](/reference/connectors/snapchat#supported-identifiers) for how the destination matches each identifier.

## 2. Activate the dataset

```bash theme={null}
curl -X POST https://api.narrative.io/datasets/{dataset_id}/activate \
  -H "Authorization: Bearer $NIO_API_TOKEN"
```

The response is `201` with the dataset, now `"status": "active"`. Activation locks the schema, so activate only once the shape is settled.

## 3. Upload and ingest your file

Each line of the file is one row that matches the schema you declared in [step 1](#1-create-the-dataset). For the columns Snapchat accepts and their shapes, see [Supported identifiers](/reference/connectors/snapchat#supported-identifiers) and [Required columns](#required-columns).

You can load a file into a dataset over the API in two ways:

* **Signed-URL upload.** Your integration uploads one file of up to 3 GB, then asks Narrative to ingest it.
* **Managed S3 bucket.** You write files to an S3 bucket that Narrative manages, and Narrative ingests each batch on its own. Use a managed bucket for files larger than 3 GB, or for files that another system delivers on a schedule.

### Choose a file format

The dataset's `file_config.type` sets the format of every file you load into it. Parquet and JSON Lines both hold object columns, which nest properties inside one column:

* **Parquet** (`parquet`) is the most compatible format for connector datasets. It stores nested struct columns and their types natively, and Narrative matches columns to the schema by name at every level.
* **JSON Lines** (`json`) holds one JSON object per line. Narrative matches each nested object to the schema by name.

CSV datasets (`flat`) hold only scalar columns, so they can't carry object columns.

### Upload a file with a signed URL

Request an upload URL, then send the file straight to storage:

```bash theme={null}
curl -X POST https://api.narrative.io/uploads/my-file.jsonl \
  -H "Authorization: Bearer $NIO_API_TOKEN"
# → {"path": "<UPLOAD_PATH>", "url": "https://...", "expiry": "..."}

curl -X PUT "<url from the response>" --upload-file ./my-file.jsonl
```

The upload URL is valid for 30 minutes and carries its own signature, so send no authorization header with the `PUT`.

<Warning>
  Keep the `path` from the response. Narrative assigns its own storage path, which does not match the name you requested, and the ingest request needs Narrative's path rather than yours.
</Warning>

Then ingest the file into the dataset, passing that `path` as `source_file`:

```bash theme={null}
curl -X POST https://api.narrative.io/datasets/{dataset_id}/upload \
  -H "Authorization: Bearer $NIO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"source_file": "<UPLOAD_PATH>"}'
```

Ingestion runs in the background. Watch the record count on the dataset to know when it has finished:

```bash theme={null}
curl -s https://api.narrative.io/datasets/{dataset_id} \
  -H "Authorization: Bearer $NIO_API_TOKEN"
# → .stats.active_dataset_stored_records
```

The count moves from zero to your row count, typically within a couple of minutes. Each ingested file adds a new snapshot to the dataset, and every active connection on the dataset delivers that snapshot.

### Write files to a managed S3 bucket

A managed bucket is an S3 bucket that Narrative creates for your company. You write each batch of files into its own folder under the dataset's path in the bucket, then write an empty `_NIO_COMMIT` file into that batch folder. Narrative ingests every file in the batch folder when the commit file appears, so you make no upload or ingest request. A file can be as large as S3 accepts.

See [Ingesting Files from a Managed S3 Bucket](/guides/ingestion/ingesting-files-from-a-managed-s3-bucket) to create the bucket, grant your AWS account access, and lay out the folders.

## 4. Confirm Snapchat accepts the dataset

Before you create a connection, ask Narrative which connector interfaces the dataset satisfies:

```bash theme={null}
curl -s https://api.narrative.io/datasets/{dataset_id}/interfaces \
  -H "Authorization: Bearer $NIO_API_TOKEN"
# → {"dataset_id": 12345,
#    "accepted": [{"app_id": <APP_ID>, "interface_id": "<INTERFACE_ID>"}, ...],
#    "errors": [{"app_id": <APP_ID>, "interface_id": "<INTERFACE_ID>", "details": {...}}, ...]}
```

The response checks the dataset's schema against every interface of the connectors your company has installed, and sorts the results into two lists:

* `accepted` lists each interface you can connect the dataset to, by the connector's `app_id` and the `interface_id`.
* `errors` lists each interface the schema does not satisfy. Its `details` hold the reason, such as `"required property '<column>' not found"`.

Add `?tags=<tag>` to check only the interfaces that carry that tag.

When the interface you want is under `errors`, the dataset's schema doesn't meet what the interface needs, for example a missing column or property. Activation locks the schema, so create a new dataset that fixes what the error names.

For Snapchat, look for the Snapchat Connector (`"app_id": 22`) with the `audience` interface in `accepted`. Add `?tags=snapchat` to check only Snapchat's interfaces.

```json theme={null}
{"app_id": 22, "interface_id": "audience"}
```

## 5. Deliver to a new customer list

Create a connection. The connector creates the customer list in Snapchat before it answers, so the list exists in Ads Manager once you get `201`.

```bash theme={null}
curl -X POST https://api.narrative.io/v2/connections \
  -H "Authorization: Bearer $NIO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "connections_dataset",
    "dataset_id": 12345,
    "profile_id": "<PROFILE_ID>",
    "quick_settings": {
      "type": "audience",
      "ad_account_id": "<AD_ACCOUNT_ID>",
      "name": "Spring Buyers",
      "description": "Bought in March or April",
      "retention_in_days": 30,
      "historical_data_enabled": true
    }
  }'
# → 201 {"type": "connections_dataset", "id": "<CONNECTION_ID>",
#        "app": {"id": 22, "name": "Snapchat Connector"}, "dataset_id": 12345,
#        "quick_settings": {"type": "audience", "name": "Spring Buyers", ...},
#        "profile_id": "<PROFILE_ID>", "status": "active", ...}
```

Both `type` fields are required. The outer one identifies what you are connecting, and the one inside `quick_settings` selects the delivery interface.

[What the connection does](/guides/connector-apis/snapchat#what-the-connection-does) describes every field, its allowed values, and its default.

Record the connection `id`. You need it to stop the delivery.

## 6. Confirm the connection

```bash theme={null}
curl -s https://api.narrative.io/v2/connections/{connection_id} \
  -H "Authorization: Bearer $NIO_API_TOKEN"

curl -s "https://api.narrative.io/v2/connections?dataset_id=12345" \
  -H "Authorization: Bearer $NIO_API_TOKEN"
```

Both responses show the connection with `"status": "active"` and the `quick_settings` you sent. In Snapchat Ads Manager, open **Audiences** and then **Audience Library**. The new list appears as a Customer List with the name, description, and retention you set.

To hear when each delivery finishes, subscribe to [delivery notifications](/guides/connector-apis/snapchat#delivery-notifications). The connector sends `audience.delivery.completed` when a delivery to the customer list finishes.

## Keeping the audience current

Write new data to the dataset with the same three calls as in [step 3](#3-upload-and-ingest-your-file). The connection keeps running, so new rows reach the customer list without further calls.

## Stopping delivery

```bash theme={null}
curl -X DELETE https://api.narrative.io/v2/connections/{connection_id} \
  -H "Authorization: Bearer $NIO_API_TOKEN"
# → 200 {}
```

Deleting the connection archives it and stops further deliveries. The customer list stays in Snapchat with its members. Delete it in Ads Manager if you no longer want it. To remove the dataset as well, send `DELETE /datasets/{dataset_id}`.

## Troubleshooting

| Symptom | Cause | Fix |
| - | - | - |
| `400` with `ad account does not exist: <AD_ACCOUNT_ID>` | The ad account is not one of the profile's advertisers | Use an `id` from [List your advertisers](/guides/connector-apis/snapchat#list-your-advertisers). If the account is new in Snapchat, reload the advertisers first |
| `400 Dataset Schema Incompatible with Connector` | No column is named after a supported identifier | Create a new dataset with a correctly named column, since activation locked the schema |

## Getting help

Contact your Narrative relationship manager with your company ID, the dataset ID, and the failing request and response.

***

## Related content

<CardGroup cols={2}>
  <Card title="Sending conversion events via the API" icon="cart-shopping" href="/guides/connector-apis/snapchat/conversion-events-api">
    Send offline conversions to a Snap Pixel
  </Card>

  <Card title="Snapchat Connector" icon="snapchat" href="/reference/connectors/snapchat">
    Supported identifiers and audience retention
  </Card>

  <Card title="Connector Interfaces" icon="plug" href="/concepts/data-activation/connector-interfaces">
    Why a dataset connects to an interface rather than a connector
  </Card>

  <Card title="API Keys" icon="key" href="/account-settings/api-keys">
    Create and rotate keys for programmatic access
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.