Meta Conversions API

App · 15 actions

Send server-side conversion events to Meta (Facebook and Instagram ads) with customer details hashed for you, check your datasets, manage custom conversions, and list your custom audiences.

Actions

ActionWhat it does
Create custom conversionCreate a custom conversion that counts visits to pages whose address contains some text, and/or a named event, on a dataset.
Get current userGet the Meta user or system user the access token belongs to.
Get custom conversionGet one custom conversion with its rule, event type and default value.
Get datasetGet one dataset with its automatic matching, cookie and data use settings.
Get dataset event countsCount the events a dataset received in the last 7 days, by event, device, browser, page or host.
List ad accountsList the ad accounts the access token can reach, with currency and status.
List custom audiencesList an ad account's custom audiences with their size and status.
List custom conversionsList an ad account's custom conversions with their rules and last activity.
List datasetsList the datasets (pixels) of an ad account with when each last received an event.
Send eventSend one server-side event (a purchase, lead, sign-up or your own) to a dataset.
Send events in a batchSend up to 1,000 events at once from a list, such as rows from a spreadsheet.
Send lead eventSend a Lead event for someone who asked to be contacted, so Meta can find more people like them.
Send purchase eventSend a Purchase event with its value and currency, so Meta can measure and optimise for sales.
Update custom conversionChange a custom conversion's name, description or default value.
Update datasetRename a dataset or change its automatic matching, first-party cookie or data use settings.

Create custom conversion

Create a custom conversion that counts visits to pages whose address contains some text, and/or a named event, on a dataset. Meta allows up to 100 per ad account.

Inputs

Ad accountad_account_idtextRequired
The ad account. Pick one, or give its id (act_ followed by digits).
NamenametextRequired
The conversion's name, shown in Ads Manager.
Datasetdataset_idtextRequired
The dataset (pixel) to use. Pick one, or give its id from Events Manager.
Page address containsurl_containstext
Count page visits whose address contains this text, ignoring case, like /thank-you.
Event nameevent_nametext
Count only this event, like Purchase. Use with, or instead of, the page address.
Conversion typecustom_event_typetext
The kind of conversion, so Meta can optimise for it. Meta guesses one if empty.One of: PURCHASE, LEAD, COMPLETE_REGISTRATION (Complete registration), ADD_TO_CART (Add to cart), INITIATED_CHECKOUT (Initiated checkout), ADD_PAYMENT_INFO (Add payment info), ADD_TO_WISHLIST (Add to wishlist), CONTENT_VIEW (Content view), SEARCH, CONTACT, and 9 more.
Default valuedefault_conversion_valuenumber
The value to credit each conversion, in the ad account's currency.At least 0.
Descriptiondescriptiontext
A short description.
Custom ruleruleobject
A rule written in Meta's JSON rule format. Overrides the page address and event name.

Outputs

idtext
The new custom conversion's id
is_custom_event_type_predictedtrue/false
True if Meta chose the conversion type
Example output
{
  "id": "2345678901234567",
  "is_custom_event_type_predicted": false
}

Get current user

Get the Meta user or system user the access token belongs to.

Inputs

None.

Outputs

userobject
The token's user
Example output
{
  "user": {
    "id": "61500000000000",
    "name": "Lodol system user"
  }
}

Get custom conversion

Get one custom conversion with its rule, event type and default value.

Inputs

Custom conversion IDcustom_conversion_idtextRequired
The custom conversion's id, from 'List custom conversions' or 'Create custom conversion'.

Outputs

custom_conversionobject
The custom conversion
Example output
{
  "custom_conversion": {
    "creation_time": "2026-10-01T09:00:00Z",
    "custom_event_type": "PURCHASE",
    "default_conversion_value": 10,
    "description": "People who reach the thank-you page",
    "id": "2345678901234567",
    "is_archived": false,
    "is_unavailable": false,
    "last_fired_time": "",
    "name": "Thank-you page visit",
    "pixel": {
      "id": "1234567890123456"
    },
    "rule": "{\"url\":{\"i_contains\":\"thank-you\"}}"
  }
}

Get dataset

Get one dataset with its automatic matching, cookie and data use settings.

Inputs

Datasetdataset_idtextRequired
The dataset (pixel) to use. Pick one, or give its id from Events Manager.

Outputs

datasetobject
The dataset
Example output
{
  "dataset": {
    "automatic_matching_fields": [
      "em",
      "ph"
    ],
    "creation_time": "2025-01-10T09:00:00Z",
    "data_use_setting": "ADVERTISING_AND_ANALYTICS",
    "enable_automatic_matching": true,
    "first_party_cookie_status": "FIRST_PARTY_COOKIE_ENABLED",
    "id": "1234567890123456",
    "is_created_by_business": true,
    "is_unavailable": false,
    "last_fired_time": "2026-10-30T14:21:00Z",
    "name": "Lodol website dataset",
    "owner_business": {
      "id": "1111111111",
      "name": "Acme Inc"
    }
  }
}

Get dataset event counts

Count the events a dataset received in the last 7 days, by event, device, browser, page or host.

Inputs

Datasetdataset_idtextRequired
The dataset (pixel) to use. Pick one, or give its id from Events Manager.
Break down byaggregationtext
What to count by. Defaults to event.One of: event (Event (default)), event_total_counts (Event totals), device_type (Device type), browser_type (Browser), host (Website host), url (Page address), pixel_fire (Pixel fires).
Fromstart_timedate and time
Start of the range. Meta keeps 7 days of data.
Untilend_timedate and time
End of the range. Defaults to now.
Sourceevent_sourcetext
Count only browser events or only server events. Leave empty for both.One of: WEB_ONLY (Browser events only), SERVER_ONLY (Server events only (Conversions API)).
Page sizelimitnumber
How many to return, 1 to 100. The default is 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many are in this page
next_cursortext
Pass as 'Next page cursor' for the next page; empty on the last page
statslist
The counts, one entry per hour or day
Example output
{
  "count": 1,
  "next_cursor": "",
  "stats": [
    {
      "aggregation": "event",
      "data": [
        {
          "count": 12,
          "value": "Purchase"
        }
      ],
      "start_time": "2026-10-30T00:00:00Z"
    }
  ]
}

List ad accounts

List the ad accounts the access token can reach, with currency and status.

Inputs

Page sizelimitnumber
How many to return, 1 to 100. The default is 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

ad_accountslist
The ad accounts
countnumber
How many are in this page
next_cursortext
Pass as 'Next page cursor' for the next page; empty on the last page
Example output
{
  "ad_accounts": [
    {
      "account_id": "1122334455",
      "account_status": 1,
      "account_status_label": "Active",
      "currency": "USD",
      "id": "act_1122334455",
      "name": "Acme Ads",
      "timezone_name": "America/Los_Angeles"
    }
  ],
  "count": 1,
  "next_cursor": ""
}

List custom audiences

List an ad account's custom audiences with their size and status.

Inputs

Ad accountad_account_idtextRequired
The ad account. Pick one, or give its id (act_ followed by digits).
Page sizelimitnumber
How many to return, 1 to 100. The default is 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

audienceslist
The custom audiences
countnumber
How many are in this page
next_cursortext
Pass as 'Next page cursor' for the next page; empty on the last page
Example output
{
  "audiences": [
    {
      "approximate_count_lower_bound": 1000,
      "approximate_count_upper_bound": 1500,
      "customer_file_source": "USER_PROVIDED_ONLY",
      "delivery_status": {
        "code": 200,
        "description": "This audience is ready for use."
      },
      "description": "Everyone on the list",
      "id": "3456789012345678",
      "name": "Newsletter subscribers",
      "operation_status": {
        "code": 200,
        "description": "Normal"
      },
      "retention_days": 180,
      "subtype": "CUSTOM",
      "time_created": "2026-09-01T09:00:00Z",
      "time_updated": "2026-10-01T09:00:00Z"
    }
  ],
  "count": 1,
  "next_cursor": ""
}

List custom conversions

List an ad account's custom conversions with their rules and last activity.

Inputs

Ad accountad_account_idtextRequired
The ad account. Pick one, or give its id (act_ followed by digits).
Page sizelimitnumber
How many to return, 1 to 100. The default is 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many are in this page
custom_conversionslist
The custom conversions
next_cursortext
Pass as 'Next page cursor' for the next page; empty on the last page
Example output
{
  "count": 1,
  "custom_conversions": [
    {
      "creation_time": "2026-10-01T09:00:00Z",
      "custom_event_type": "PURCHASE",
      "default_conversion_value": 10,
      "description": "People who reach the thank-you page",
      "id": "2345678901234567",
      "is_archived": false,
      "is_unavailable": false,
      "last_fired_time": "",
      "name": "Thank-you page visit",
      "pixel": {
        "id": "1234567890123456"
      },
      "rule": "{\"url\":{\"i_contains\":\"thank-you\"}}"
    }
  ],
  "next_cursor": ""
}

List datasets

List the datasets (pixels) of an ad account with when each last received an event.

Inputs

Ad accountad_account_idtextRequired
The ad account. Pick one, or give its id (act_ followed by digits).
Page sizelimitnumber
How many to return, 1 to 100. The default is 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many are in this page
datasetslist
The datasets
next_cursortext
Pass as 'Next page cursor' for the next page; empty on the last page
Example output
{
  "count": 1,
  "datasets": [
    {
      "creation_time": "2025-01-10T09:00:00Z",
      "id": "1234567890123456",
      "is_unavailable": false,
      "last_fired_time": "2026-10-30T14:21:00Z",
      "name": "Lodol website dataset"
    }
  ],
  "next_cursor": ""
}

Send event

Send one server-side event (a purchase, lead, sign-up or your own) to a dataset. Emails, phones and names are hashed for you; add a test event code to try it safely.

Inputs

Datasetdataset_idtextRequired
The dataset (pixel) to use. Pick one, or give its id from Events Manager.
Eventevent_nametextRequired
What happened. Pick Custom event to use your own name.One of: Purchase, Lead, CompleteRegistration (Complete registration), AddToCart (Add to cart), InitiateCheckout (Initiate checkout), AddPaymentInfo (Add payment info), AddToWishlist (Add to wishlist), ViewContent (View content), Search, Contact, and 8 more.
Custom event namecustom_event_nametext
The name of your custom event, like QuoteRequested.Only when Event is Custom event (name it below).
Valuevaluenumber
The value of the event in the currency below, like 49.90.At least 0.
Currencycurrencytext
A three-letter currency code, like USD.
Order IDorder_idtext
Your order or transaction id.
Product IDscontent_idslist
The product ids involved, one per row.
Product ID typecontent_typetext
Whether the ids are products or product groups.One of: product, product_group (Product group).
Content namecontent_nametext
The name of the product or page.
Content categorycontent_categorytext
The category of the product or page.
Number of itemsnum_itemsnumber
How many items, as a whole number.At least 0.
Other detailscustom_propertiesobject
Any other details to send with the event, as keys and values.
Emailemailtext
The customer's email address. It is lowercased and hashed for you.
Phonephonetext
The customer's phone number with its country code, like +1 650 555 1212. Symbols and leading zeros are removed and it is hashed for you.
First namefirst_nametext
First name. Lowercased and hashed for you.
Last namelast_nametext
Last name. Lowercased and hashed for you.
Date of birthdate_of_birthdate
Date of birth. Sent as YYYYMMDD after hashing.
Gendergendertext
Gender, as Meta matches it.One of: f (Female), m (Male).
Citycitytext
City. Lowercased, letters only, then hashed.
Statestatetext
State or region. Use the two-letter code for the US, like CA.
Zip codezip_codetext
Postal code. US codes are cut to the first 5 digits.
Countrycountrytext
Two-letter ISO country code, like US or GB.
External IDexternal_idtext
Your own id for this customer (a CRM or user id). It is hashed for you.
IP addressclient_ip_addresstext
The visitor's IPv4 or IPv6 address. Sent as it is, never hashed.
Browser user agentclient_user_agenttext
The visitor's browser user agent. Required for website events. Sent as it is.
Click ID (fbc)fbctext
The _fbc cookie value, or fb.1.<time>.<fbclid> built from the ad click.
Browser ID (fbp)fbptext
The _fbp browser cookie value.
Lead IDlead_idtext
The Meta Lead Ads lead id, for events about a lead from a lead form.
Event timeevent_timedate and time
When it happened. Defaults to now. Meta accepts events up to 7 days old (62 for physical store events).
Where it happenedaction_sourcetext
Where the event happened. Defaults to website.One of: website (Website (default)), app, email, phone_call (Phone call), chat, physical_store (Physical store), system_generated (System generated (such as a subscription renewal)), business_messaging (Business messaging), other.
Page addressevent_source_urltext
The page address where it happened. Required for website events.
Event IDevent_idtext
A unique id for this event. If your browser pixel sends the same event with the same id, Meta counts it once.
Test event codetest_event_codetext
The code from Events Manager's Test events tab (such as TEST12345). With it, the event shows only under Test events and is kept out of real reporting. Leave empty to send live data.
Limited Data Uselimited_data_usetrue/false
Turn on to mark the event for Meta's Limited Data Use, which restricts how Meta uses US customers' data.

Outputs

dataset_idtext
The dataset the events went to
eventslist
The events as sent, with customer details hashed
events_receivednumber
How many events Meta says it received
events_sentnumber
How many events Lodol sent
fbtrace_idtext
Meta's trace id, for support
messageslist
Warnings Meta returned, if any
test_modetrue/false
True when a test event code was used
Example output
{
  "dataset_id": "1234567890123456",
  "events": [
    {
      "action_source": "website",
      "custom_data": {
        "currency": "USD",
        "value": 49.9
      },
      "event_id": "order-1001",
      "event_name": "Purchase",
      "event_source_url": "https://example.com/thank-you",
      "event_time": 1793000000,
      "user_data": {
        "client_user_agent": "Mozilla/5.0",
        "em": [
          "b36a0b3c8ce2d3f1e2ca5e6a2d6cbb6b3b2f8d2f6f5a0f2f9c3bd7e1d0a1c2e3"
        ]
      }
    }
  ],
  "events_received": 1,
  "events_sent": 1,
  "fbtrace_id": "AbCdEfGh123",
  "messages": [],
  "test_mode": true
}

Send events in a batch

Send up to 1,000 events at once from a list, such as rows from a spreadsheet. Each event's user_data holds plain values (email, phone, first_name...) that are hashed for you.

Inputs

Datasetdataset_idtextRequired
The dataset (pixel) to use. Pick one, or give its id from Events Manager.
EventseventslistRequired
The events, each an object with event_name, optional event_time (Unix seconds or ISO 8601), action_source, event_source_url, event_id, user_data (plain email, phone, first_name, last_name, ...) and custom_data (value, currency, ...).
Test event codetest_event_codetext
The code from Events Manager's Test events tab (such as TEST12345). With it, the event shows only under Test events and is kept out of real reporting. Leave empty to send live data.

Outputs

dataset_idtext
The dataset the events went to
eventslist
The events as sent, with customer details hashed
events_receivednumber
How many events Meta says it received
events_sentnumber
How many events Lodol sent
fbtrace_idtext
Meta's trace id, for support
messageslist
Warnings Meta returned, if any
test_modetrue/false
True when a test event code was used
Example output
{
  "dataset_id": "1234567890123456",
  "events": [
    {
      "action_source": "website",
      "custom_data": {
        "currency": "USD",
        "value": 49.9
      },
      "event_id": "order-1001",
      "event_name": "Purchase",
      "event_source_url": "https://example.com/thank-you",
      "event_time": 1793000000,
      "user_data": {
        "client_user_agent": "Mozilla/5.0",
        "em": [
          "b36a0b3c8ce2d3f1e2ca5e6a2d6cbb6b3b2f8d2f6f5a0f2f9c3bd7e1d0a1c2e3"
        ]
      }
    }
  ],
  "events_received": 1,
  "events_sent": 1,
  "fbtrace_id": "AbCdEfGh123",
  "messages": [],
  "test_mode": true
}

Send lead event

Send a Lead event for someone who asked to be contacted, so Meta can find more people like them. Customer details are hashed for you.

Inputs

Datasetdataset_idtextRequired
The dataset (pixel) to use. Pick one, or give its id from Events Manager.
Valuevaluenumber
The value of the event in the currency below, like 49.90.At least 0.
Currencycurrencytext
A three-letter currency code, like USD.
Order IDorder_idtext
Your order or transaction id.
Product IDscontent_idslist
The product ids involved, one per row.
Product ID typecontent_typetext
Whether the ids are products or product groups.One of: product, product_group (Product group).
Content namecontent_nametext
The name of the product or page.
Content categorycontent_categorytext
The category of the product or page.
Number of itemsnum_itemsnumber
How many items, as a whole number.At least 0.
Other detailscustom_propertiesobject
Any other details to send with the event, as keys and values.
Emailemailtext
The customer's email address. It is lowercased and hashed for you.
Phonephonetext
The customer's phone number with its country code, like +1 650 555 1212. Symbols and leading zeros are removed and it is hashed for you.
First namefirst_nametext
First name. Lowercased and hashed for you.
Last namelast_nametext
Last name. Lowercased and hashed for you.
Date of birthdate_of_birthdate
Date of birth. Sent as YYYYMMDD after hashing.
Gendergendertext
Gender, as Meta matches it.One of: f (Female), m (Male).
Citycitytext
City. Lowercased, letters only, then hashed.
Statestatetext
State or region. Use the two-letter code for the US, like CA.
Zip codezip_codetext
Postal code. US codes are cut to the first 5 digits.
Countrycountrytext
Two-letter ISO country code, like US or GB.
External IDexternal_idtext
Your own id for this customer (a CRM or user id). It is hashed for you.
IP addressclient_ip_addresstext
The visitor's IPv4 or IPv6 address. Sent as it is, never hashed.
Browser user agentclient_user_agenttext
The visitor's browser user agent. Required for website events. Sent as it is.
Click ID (fbc)fbctext
The _fbc cookie value, or fb.1.<time>.<fbclid> built from the ad click.
Browser ID (fbp)fbptext
The _fbp browser cookie value.
Lead IDlead_idtext
The Meta Lead Ads lead id, for events about a lead from a lead form.
Event timeevent_timedate and time
When it happened. Defaults to now. Meta accepts events up to 7 days old (62 for physical store events).
Where it happenedaction_sourcetext
Where the event happened. Defaults to website.One of: website (Website (default)), app, email, phone_call (Phone call), chat, physical_store (Physical store), system_generated (System generated (such as a subscription renewal)), business_messaging (Business messaging), other.
Page addressevent_source_urltext
The page address where it happened. Required for website events.
Event IDevent_idtext
A unique id for this event. If your browser pixel sends the same event with the same id, Meta counts it once.
Test event codetest_event_codetext
The code from Events Manager's Test events tab (such as TEST12345). With it, the event shows only under Test events and is kept out of real reporting. Leave empty to send live data.
Limited Data Uselimited_data_usetrue/false
Turn on to mark the event for Meta's Limited Data Use, which restricts how Meta uses US customers' data.

Outputs

dataset_idtext
The dataset the events went to
eventslist
The events as sent, with customer details hashed
events_receivednumber
How many events Meta says it received
events_sentnumber
How many events Lodol sent
fbtrace_idtext
Meta's trace id, for support
messageslist
Warnings Meta returned, if any
test_modetrue/false
True when a test event code was used
Example output
{
  "dataset_id": "1234567890123456",
  "events": [
    {
      "action_source": "website",
      "custom_data": {
        "currency": "USD",
        "value": 49.9
      },
      "event_id": "order-1001",
      "event_name": "Lead",
      "event_source_url": "https://example.com/thank-you",
      "event_time": 1793000000,
      "user_data": {
        "client_user_agent": "Mozilla/5.0",
        "em": [
          "b36a0b3c8ce2d3f1e2ca5e6a2d6cbb6b3b2f8d2f6f5a0f2f9c3bd7e1d0a1c2e3"
        ]
      }
    }
  ],
  "events_received": 1,
  "events_sent": 1,
  "fbtrace_id": "AbCdEfGh123",
  "messages": [],
  "test_mode": true
}

Send purchase event

Send a Purchase event with its value and currency, so Meta can measure and optimise for sales. Customer details are hashed for you.

Inputs

Datasetdataset_idtextRequired
The dataset (pixel) to use. Pick one, or give its id from Events Manager.
ValuevaluenumberRequired
The value of the event in the currency below, like 49.90.At least 0.
CurrencycurrencytextRequired
A three-letter currency code, like USD.
Order IDorder_idtext
Your order or transaction id.
Product IDscontent_idslist
The product ids involved, one per row.
Product ID typecontent_typetext
Whether the ids are products or product groups.One of: product, product_group (Product group).
Content namecontent_nametext
The name of the product or page.
Content categorycontent_categorytext
The category of the product or page.
Number of itemsnum_itemsnumber
How many items, as a whole number.At least 0.
Other detailscustom_propertiesobject
Any other details to send with the event, as keys and values.
Emailemailtext
The customer's email address. It is lowercased and hashed for you.
Phonephonetext
The customer's phone number with its country code, like +1 650 555 1212. Symbols and leading zeros are removed and it is hashed for you.
First namefirst_nametext
First name. Lowercased and hashed for you.
Last namelast_nametext
Last name. Lowercased and hashed for you.
Date of birthdate_of_birthdate
Date of birth. Sent as YYYYMMDD after hashing.
Gendergendertext
Gender, as Meta matches it.One of: f (Female), m (Male).
Citycitytext
City. Lowercased, letters only, then hashed.
Statestatetext
State or region. Use the two-letter code for the US, like CA.
Zip codezip_codetext
Postal code. US codes are cut to the first 5 digits.
Countrycountrytext
Two-letter ISO country code, like US or GB.
External IDexternal_idtext
Your own id for this customer (a CRM or user id). It is hashed for you.
IP addressclient_ip_addresstext
The visitor's IPv4 or IPv6 address. Sent as it is, never hashed.
Browser user agentclient_user_agenttext
The visitor's browser user agent. Required for website events. Sent as it is.
Click ID (fbc)fbctext
The _fbc cookie value, or fb.1.<time>.<fbclid> built from the ad click.
Browser ID (fbp)fbptext
The _fbp browser cookie value.
Lead IDlead_idtext
The Meta Lead Ads lead id, for events about a lead from a lead form.
Event timeevent_timedate and time
When it happened. Defaults to now. Meta accepts events up to 7 days old (62 for physical store events).
Where it happenedaction_sourcetext
Where the event happened. Defaults to website.One of: website (Website (default)), app, email, phone_call (Phone call), chat, physical_store (Physical store), system_generated (System generated (such as a subscription renewal)), business_messaging (Business messaging), other.
Page addressevent_source_urltext
The page address where it happened. Required for website events.
Event IDevent_idtext
A unique id for this event. If your browser pixel sends the same event with the same id, Meta counts it once.
Test event codetest_event_codetext
The code from Events Manager's Test events tab (such as TEST12345). With it, the event shows only under Test events and is kept out of real reporting. Leave empty to send live data.
Limited Data Uselimited_data_usetrue/false
Turn on to mark the event for Meta's Limited Data Use, which restricts how Meta uses US customers' data.

Outputs

dataset_idtext
The dataset the events went to
eventslist
The events as sent, with customer details hashed
events_receivednumber
How many events Meta says it received
events_sentnumber
How many events Lodol sent
fbtrace_idtext
Meta's trace id, for support
messageslist
Warnings Meta returned, if any
test_modetrue/false
True when a test event code was used
Example output
{
  "dataset_id": "1234567890123456",
  "events": [
    {
      "action_source": "website",
      "custom_data": {
        "currency": "USD",
        "value": 49.9
      },
      "event_id": "order-1001",
      "event_name": "Purchase",
      "event_source_url": "https://example.com/thank-you",
      "event_time": 1793000000,
      "user_data": {
        "client_user_agent": "Mozilla/5.0",
        "em": [
          "b36a0b3c8ce2d3f1e2ca5e6a2d6cbb6b3b2f8d2f6f5a0f2f9c3bd7e1d0a1c2e3"
        ]
      }
    }
  ],
  "events_received": 1,
  "events_sent": 1,
  "fbtrace_id": "AbCdEfGh123",
  "messages": [],
  "test_mode": true
}

Update custom conversion

Change a custom conversion's name, description or default value. Meta does not allow changing its rule.

Inputs

Custom conversion IDcustom_conversion_idtextRequired
The custom conversion's id, from 'List custom conversions' or 'Create custom conversion'.
Namenametext
A new name. Leave empty to keep it.
Descriptiondescriptiontext
A new description. Leave empty to keep it.
Default valuedefault_conversion_valuenumber
A new default value. Leave empty to keep it.At least 0.

Outputs

idtext
The id updated
updatedtrue/false
Always true once updated
Example output
{
  "id": "2345678901234567",
  "updated": true
}

Update dataset

Rename a dataset or change its automatic matching, first-party cookie or data use settings. Only the fields given change.

Inputs

Datasetdataset_idtextRequired
The dataset (pixel) to use. Pick one, or give its id from Events Manager.
Namenametext
A new name. Leave empty to keep it.
Automatic matchingautomatic_matchingtext
Turn automatic advanced matching on or off. Leave empty to keep it.One of: on, off.
Matching detailsautomatic_matching_fieldslist
Which customer details automatic matching may use. Leave empty to keep them.One or more of: em (Email), ph (Phone), fn (First name), ln (Last name), ge (Gender), db (Date of birth), ct (City), st (State), zp (Zip code), country, external_id (External ID).
First-party cookiesfirst_party_cookie_statustext
Whether the pixel uses first-party cookies. Leave empty to keep it.One of: FIRST_PARTY_COOKIE_ENABLED (Use first-party cookies), FIRST_PARTY_COOKIE_DISABLED (Do not use first-party cookies), EMPTY (Not set).
Data usedata_use_settingtext
How Meta may use the data. Leave empty to keep it.One of: ADVERTISING_AND_ANALYTICS (Advertising and analytics), ANALYTICS_ONLY (Analytics only), EMPTY (Not set).

Outputs

datasetobject
The dataset after the change
updatedtrue/false
Always true once updated
Example output
{
  "dataset": {
    "automatic_matching_fields": [
      "em",
      "ph"
    ],
    "creation_time": "2025-01-10T09:00:00Z",
    "data_use_setting": "ADVERTISING_AND_ANALYTICS",
    "enable_automatic_matching": true,
    "first_party_cookie_status": "FIRST_PARTY_COOKIE_ENABLED",
    "id": "1234567890123456",
    "is_created_by_business": true,
    "is_unavailable": false,
    "last_fired_time": "2026-10-30T14:21:00Z",
    "name": "Renamed dataset",
    "owner_business": {
      "id": "1111111111",
      "name": "Acme Inc"
    }
  },
  "updated": true
}

On this page