All URIs are relative to https://zernio.com/api
| Method | HTTP request | Description |
|---|---|---|
| add_users_to_ad_audience | POST /v1/ads/audiences/{audienceId}/users | Add users to audience |
| create_ad_audience | POST /v1/ads/audiences | Create custom audience |
| delete_ad_audience | DELETE /v1/ads/audiences/{audienceId} | Delete custom audience |
| get_ad_audience | GET /v1/ads/audiences/{audienceId} | Get audience details |
| list_ad_audiences | GET /v1/ads/audiences | List custom audiences |
| replace_ad_audience_companies | POST /v1/ads/audiences/{audienceId}/companies | Replace audience companies |
| update_ad_audience | PUT /v1/ads/audiences/{audienceId} | Update an audience |
models::AddUsersToAdAudience200Response add_users_to_ad_audience(audience_id, add_users_to_ad_audience_request) Add users to audience
Upload user data to a customer_list audience. Data is SHA256-hashed server-side before sending to the platform. Email is used on every platform; phone is used on Meta only (other platforms ignore it). On TikTok and Pinterest, the first upload also provisions the audience (deferred create). LinkedIn uploads are full-replace. Max 10,000 users per request. customer_list only. A LinkedIn company_list audience takes company rows, not people: send those to POST /v1/ads/audiences/{audienceId}/companies. This endpoint 422s for every other audience type.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| audience_id | String | [required] | ||
| add_users_to_ad_audience_request | AddUsersToAdAudienceRequest | [required] |
models::AddUsersToAdAudience200Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::CreateAdAudience201Response create_ad_audience(create_ad_audience_request) Create custom audience
Create a custom audience. customer_list is supported on Meta, Google, X, LinkedIn, TikTok, and Pinterest; website and lookalike are Meta-only; company_list, engagement and website_retargeting are LinkedIn-only. saved_targeting stores a reusable TargetingSpec (no member upload, no adAccountId) that you reference later via savedTargetingId on POST /v1/ads/create. How the audience gets filled depends on the type: - customer_list is created empty. Add members with POST /v1/ads/audiences/{audienceId}/users. On TikTok and Pinterest the audience is provisioned lazily on that first upload (until then its status is pending). - company_list is filled AT CREATION from the companies array below, which is required. To change the list afterwards send the new full list to POST /v1/ads/audiences/{audienceId}/companies (a replace, not a merge). The /users endpoint rejects these audiences with a 422. - website, website_retargeting, engagement, meta_engagement and lookalike fill themselves from the pixel, engagement source or seed audience you point them at. They take no member upload at all. Create is not idempotent, never auto-retry.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| create_ad_audience_request | CreateAdAudienceRequest | [required] |
models::CreateAdAudience201Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::DeleteAccountGroup200Response delete_ad_audience(audience_id) Delete custom audience
Deletes the audience from both the platform and the local database. saved_targeting audiences exist only on Zernio, so only the local record is removed.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| audience_id | String | [required] |
models::DeleteAccountGroup200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::GetAdAudience200Response get_ad_audience(audience_id) Get audience details
Returns the local audience record and fresh data from Meta (if available).
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| audience_id | String | [required] |
models::GetAdAudience200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::ListAdAudiences200Response list_ad_audiences(account_id, ad_account_id, platform, r#type) List custom audiences
Returns custom audiences for the given ad account. Supports Meta, Google, TikTok, Pinterest, LinkedIn, and X (Twitter).
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| account_id | String | Social account ID | [required] | |
| ad_account_id | String | Platform ad account ID | [required] | |
| platform | Option<String> | |||
| r#type | Option<String> | Filter to one audience type. saved_targeting returns stored TargetingSpec audiences; the other types return uploaded/derived audiences. |
models::ListAdAudiences200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::ReplaceAdAudienceCompanies200Response replace_ad_audience_companies(audience_id, replace_ad_audience_companies_request) Replace audience companies
Upload the company rows of a LinkedIn company_list audience (account-based marketing). LinkedIn-only, every other platform returns 422. A LinkedIn audience segment holds exactly one uploaded list, so the list you send here REPLACES the segment's list instead of being appended to it: always send the full set of companies. LinkedIn returns only the identifier of the uploaded file, never its rows, so the merge cannot be done for you, keep the source list on your side. LinkedIn does not document how quickly companies dropped from the list stop being targeted, so treat removals as eventual rather than immediate. Rows are plain text (not hashed), matched against LinkedIn's own company graph. Matching is asynchronous: LinkedIn takes up to 48h for a new audience and up to 24h for a later update, and the audience stays processing meanwhile. LinkedIn recommends at least 1,000 companies for a usable match rate, and caps a list at 300,000. The initial list is sent with companies on POST /v1/ads/audiences; this endpoint is for every change after that.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| audience_id | String | [required] | ||
| replace_ad_audience_companies_request | ReplaceAdAudienceCompaniesRequest | [required] |
models::ReplaceAdAudienceCompanies200Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::CreateAdAudience201Response update_ad_audience(audience_id, update_ad_audience_request) Update an audience
Update an audience. saved_targeting audiences accept name, description, and spec (full replacement, no merge, Zernio-only, no platform call). Platform audiences (uploaded/website/lookalike) accept name and description only, updated on the platform first and then mirrored locally; their rules are immutable, so spec returns 400 for them. Platform audience updates are Meta-only for now (other platforms return 501). Ads already created from a saved_targeting audience are unaffected, they snapshot the targeting at creation.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| audience_id | String | [required] | ||
| update_ad_audience_request | UpdateAdAudienceRequest | [required] |
models::CreateAdAudience201Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]