Sign in

v29

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-06-042661,1122.5 MB
lead_ads

Create lead ads subscription

Create a lead ads webhook subscription. Subscriptions allow Pinterest to deliver lead data from Ads Manager directly to the subscriber. Subscriptions can exist for a specific lead form or at ad account level.

  • Only requests for the OWNER or ADMIN of the ad_account will be allowed.
  • Advertisers can set up multiple integrations using ad_account_id + lead_form_id but only one integration per unique records.
  • For data security, egress lead data is encrypted with AES-256-GCM.
post/ad_accounts/{ad_account_id}/leads/subscriptions

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Request body

lead_form_idstring

Lead form ID.

webhook_urlstring required

Standard HTTPS webhook URL.

Response

The request has succeeded.

ad_account_idstring

The Ad Account ID that this lead form belongs to.

api_versionstring

API version.

created_timeinteger

Subscription creation time. Unix timestamp in milliseconds.

cryptographic_algorithmstring nullable

Lead data encryption algorithm.

cryptographic_keystring nullable

Base64 encoded key for client to decrypt lead data.

idstring

Subscription ID.

lead_form_idstring nullable

Lead form ID.

user_account_idstring

User account used to subscribe lead data.

webhook_urlstring

Standard HTTPS webhook URL.