> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Duplicate an Ad > Copies the ad into its own ad group, or into target_ad_group_id (which must belong to the same account and be compatible with the ad). Copies keep the source ad's active/paused state. ## OpenAPI ````yaml /openapi/api-v1-native.json post /ads/{id}/duplicate openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: '2026-07-22' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: > An Account represents a person or business on Whop that can have its own profile, wallet, and account-scoped settings. Use accounts for customers, creators, merchants, sellers, or connected businesses your integration supports. Use the Accounts API to create accounts, list accounts visible to your credentials, retrieve or update an account, and retrieve the account associated with the current API key. name: Accounts x-whop-summary: 'A business on Whop: profile, wallet, capabilities, settings.' - description: > A User represents a person on Whop. Users have a public profile and can buy products, join accounts, and access experiences. Use the Users API to search for users, retrieve or update profiles, and check whether a user has access to an account, product, or experience. name: Users x-whop-summary: 'A person on Whop: profile and connected identities.' - description: > A Team Member is a member of an account's team: the link between a user and an account, carrying the role that controls what they can do. Roles are either system roles (like `admin` or `moderator`) or `custom` roles managed from the dashboard. Use the Team Members API to list an account's team, add a user to the team with a system role, change a member's role, and remove members. Adding a user who has not yet accepted sends an invitation instead. name: Team Members x-whop-summary: An account's team members and the roles that scope their access. - name: Webhooks x-whop-summary: Event notifications pushed to your server as things happen. - description: > Stats represent aggregated activity for an account over time. They help you understand revenue, transactions, disputes, members, referrals, and advertising performance across reporting periods like days, weeks, or months. Use the Stats API to list available metrics and their filterable properties, then retrieve time-series values for a date range. name: Stats x-whop-summary: Aggregated financial, audience, and traffic reporting. - description: > A Verification represents a legal identity for a person or business. Accounts and users complete verification when Whop needs to confirm who they are before enabling payouts or compliance-sensitive workflows. Use the Verifications API to start or resume a hosted verification session, check review status, and submit requested details or documents. If `requested_information` contains items, submit answers with [Update Verification](/api-reference/beta/verifications/update-verification). name: Verifications x-whop-summary: Legal identity required before payouts and card issuing. - description: > A Ledger Activity row is a single financial event on an account's ledger — a payment, withdrawal, refund, transfer, on-chain deposit, swap, or card transaction. Each row is derived from the underlying ledger lines and carries a typed `resource` and `source` so you can present and link the event without extra lookups. Use Ledger Activity to build a statement or transaction feed for an account or user. Reconcile against your own records with `amount` (signed, in the currency's smallest precision units) and `posted_at`, and use `available_at` to know when inflows became withdrawable. name: Ledgers x-whop-summary: The activity feed behind an account or user's balance. - description: > Payouts represent money sent from an account or user balance to an external destination, such as a bank account, wallet, or other saved payout method. Use the Payouts API to create payouts from stablecoin accounts, list payout history for accounts or users, monitor payout statuses, and show expected arrival details for funds leaving Whop. name: Payouts x-whop-summary: Send money from a balance to a bank or wallet. - description: > Cards represent Whop-issued virtual payment cards that spend from an account or user balance. Cards can be assigned to cardholders and configured with spending limits for controlled spending. Use the Cards API to issue cards, list cards for an account or user, and retrieve active card details such as the card number and CVC. name: Cards x-whop-summary: Issue cards that spend from a balance. - description: > Transfers move value between identities on Whop. They are used for account-to-account money movement, user payouts inside Whop, crypto transfers, and claim links depending on the destination type. Use the Transfers API to create a transfer, list previous transfers, and retrieve a transfer by ID when reconciling money movement between accounts or users. name: Transfers x-whop-summary: Move funds between Whop accounts and users. - description: > Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses. Use the Deposits API to create deposit instructions for an account. name: Deposits x-whop-summary: Add funds to a balance. - description: > Swaps convert value between supported tokens, chains, or wallet destinations for an account. A swap quote describes the expected output, fees, and approval requirements before you create the swap. Use the Swaps API to quote a conversion, create the swap, list recent swaps, and retrieve status until the transaction completes. name: Swaps x-whop-summary: Convert a balance between currencies. - description: > A Product is a digital good or service sold on Whop. Products may contain plans for pricing and/or experiences for content delivery. Use the Products API to create products, list products visible to your credentials, retrieve product details, update product metadata or merchandising fields, and delete products that should no longer be sold. name: Products x-whop-summary: The things you sell. Each owns plans and a store page. - description: > A Plan defines how customers buy a product. It controls pricing, billing cadence, availability, tax behavior, checkout fields, and purchase visibility. Use the Plans API to create plans for products, list existing plans, retrieve or update plan configuration, calculate tax for checkout, and delete plans that should no longer be offered. name: Plans x-whop-summary: 'Pricing for a product: one-time, recurring, trials, stock.' - description: > A Checkout Configuration is a reusable checkout link owned by an account. In `payment` mode it sells a specific plan; in `setup` mode it collects and saves payment details without charging. Each configuration can also override which payment methods are accepted and how 3D Secure is enforced for that checkout. Use the Checkout Configurations API to create checkout links for an existing or inline plan, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used. name: Checkout Configurations x-whop-summary: Turn a plan into a shareable, prefilled checkout link. - description: > The Partners API covers your Whop partner activity: the users you referred onto Whop, the businesses you referred and the earnings generated from their processing volume, and the partner leaderboard. Use it to enroll as a Whop partner, list the users you referred, list your referred businesses and review their earnings, and see the partner leaderboard. name: Partners x-whop-summary: >- The users and businesses you referred to Whop, and what you earn from them. - description: > A Bounty is a paid task posted by an account or user. The reward is held in escrow when the bounty publishes, workers submit proof of completed work, and each accepted submission is paid out until every winner slot fills. Use the Bounties API to create and publish a bounty, list an account's bounties for reporting or dashboards, list the bounties a user can work or has participated in, and retrieve a single bounty by ID. name: Bounties x-whop-summary: Paid tasks with reviewed submissions and escrowed rewards. - description: > A Bounty Submission is one worker's attempt on a bounty. It starts as an in-progress attempt, enters the review queue when proof is submitted, and ends approved (paid from the bounty's escrowed pool) or denied. Use the Bounty Submissions API to submit proof of completed work to a bounty, list the submissions you authored, and review the submissions on your bounties — across every bounty or narrowed to one. name: Bounty Submissions x-whop-summary: Work submitted to a bounty, from attempt to payout. - description: > A Person represents a visitor or customer of an account, assembled from [pixel events](/api-reference/beta/events/event) and purchase activity — ad clicks, storefront visits, and checkouts. Use the People API to list the people of an account and retrieve a single person. name: People x-whop-summary: Visitors and customers of an account, aggregated from pixel events. - description: > An Event records conversion or engagement activity for an account, such as page views, purchases, or leads. Each event ties the action to the [person](/api-reference/beta/people/person) who took it, so activity can be attributed to the ads and links that drove it. Use the Events API to send new tracking events, list recent identity-linked events for an account, and inspect the events recorded for a person. name: Events x-whop-summary: Conversion and engagement events tracked for attribution. - description: > An Ad is the individual creative unit delivered by an [ad group](/api-reference/beta/ad-groups/ad-group). It holds the copy, creative assets, and destination URL for one ad. Use the Ads API to list ads for an account, create ads inside ad groups, retrieve or update creative details, delete ads that should stop running, and pause or resume delivery. name: Ads x-whop-summary: 'The creative: copy, assets, and destination URL.' - description: > An Ad Campaign is the top-level container for paid ads on an ad network. It sets the platform, objective, and budget strategy shared by its [ad groups](/api-reference/beta/ad-groups/ad-group) and ads. Use the Ad Campaigns API to create campaigns, list campaigns for an account, retrieve or update campaign settings, and pause or resume campaign delivery. name: Ad Campaigns x-whop-summary: Platform, objective, and budget for a set of ads. - description: > An Ad Group sits inside an [ad campaign](/api-reference/beta/ad-campaigns/ad-campaign) and controls delivery for [ads](/api-reference/beta/ads/ad). It sets the audience, placements, schedule, budget, and optimization goal for its ads. Use the Ad Groups API to create ad groups in campaigns, list or retrieve targeting and delivery settings, update budgets or targeting, delete groups that should stop running, and pause or resume delivery. It can also search the ad platform's targeting taxonomy for options to target and estimate how many people a draft targeting spec can reach. name: Ad Groups x-whop-summary: Audience, placements, and schedule within a campaign. - description: > An Audience represents a customer list uploaded to Whop for ad targeting. Audiences belong to an account and sync to supported ad platforms as custom audiences. Use the Audiences API to create audiences from CSV uploads, monitor processing status, and list or delete audiences for an account. Created audiences are usable for targeting after processing reaches `ready` or `partial`. name: Audiences x-whop-summary: Reusable targeting lists for ad groups. - description: > A Media Asset is an AI-generated image or video created from a prompt and billed from an account balance. When generation finishes, the asset includes a file that can be attached anywhere Whop accepts files. Use the Media API to start a generation job and retrieve the asset while it processes or after it is ready. name: Media x-whop-summary: >- AI-generated assets, billed from a balance, attachable wherever files are accepted. - description: > A Social Account represents an external profile connected to a Whop account or user, such as a Facebook page or Instagram account. Connecting a social account lets Whop run [ads](/api-reference/beta/ads/ad) under that profile's identity and promote its existing posts. Use the Social Accounts API to list connected accounts, create a Whop-managed Facebook page, start an OAuth connection, disconnect a social account, and list a connected profile's posts or a Facebook page's lead forms. name: Social Accounts x-whop-summary: Connected Facebook and Instagram accounts that run ads. - description: > An App is software you build on Whop. It can be a hosted web app served at `.whop.app` or an API integration installed as an experience, and it belongs to the account that owns its credentials, settings, builds, and runtime logs. Use the Apps API to manage app configuration and, for hosted apps, read server runtime logs for console output, uncaught exceptions, and failed requests. Logs are retained for 7 days and can be filtered by build, level, time window, and message text. name: Apps x-whop-summary: 'Apps you build on Whop: metadata, hosted builds, runtime logs.' - description: > An App Build is a versioned artifact uploaded for an app — a hosted web archive, or an iOS/Android bundle. Builds start as drafts, go through review, and one approved build per platform is served to users as the production build. Use the App Builds API to upload a build for an app, list an app's builds with platform and status filters, retrieve a build, and promote a draft or approved build to production. name: App Builds x-whop-summary: Versioned build artifacts deployed to an app's platforms. - description: > An API Key is a programmatic credential owned by an account or app. Each key carries its own permissions policy — explicit permission statements or an inherited system role — and can be restricted with an expiration date and an IP allowlist. Use the API Keys API to list a company or app's keys, create a key (the full secret is returned once, on creation), inspect a key's effective grants, update its name or restrictions, rotate its secret, and revoke it. These endpoints require a user session — they cannot be called with an API key. name: API Keys x-whop-summary: Programmatic credentials for an account or app. paths: /ads/{id}/duplicate: parameters: - $ref: '#/components/parameters/ApiVersionDate' - description: The ad ID. in: path name: id required: true schema: type: string post: tags: - Ads summary: Duplicate an Ad description: >- Copies the ad into its own ad group, or into target_ad_group_id (which must belong to the same account and be compatible with the ad). Copies keep the source ad's active/paused state. operationId: duplicateAd parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/json: schema: properties: count: description: Number of copies to create (1-10). Defaults to 1. type: integer preserve_engagement: description: >- Whether the copies keep the original post's engagement (likes, comments, shares). Defaults to false. type: boolean target_ad_group_id: description: >- Ad group to duplicate into. Defaults to the ad's own ad group. type: string type: object responses: '201': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Ad' type: array required: - data type: object description: ad duplicated '400': $ref: '#/components/responses/InvalidParameters' description: target ad group on a different ad account '404': $ref: '#/components/responses/NotFound' description: ad not found security: - bearerAuth: - ad_campaign:create x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); const response = await client.ads.duplicate('id'); console.log(response.data); components: parameters: ApiVersionDate: description: Pins the request to a dated API version. in: header name: Api-Version-Date required: false schema: example: '2026-07-22' type: string IdempotencyKey: description: >- A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). in: header name: Idempotency-Key required: false schema: example: d9105228-4a08-46b1-8b91-42fed586d383 maxLength: 255 type: string schemas: Ad: properties: ad_campaign: $ref: '#/components/schemas/AdEntityReference' description: The ad campaign this ad belongs to. ad_group: $ref: '#/components/schemas/AdEntityReference' description: The ad group this ad belongs to. added_to_cart_value: description: >- USD value attributed to add-to-cart events. Sums the value sent with each event, normalized to USD; events without a value contribute 0. type: number added_to_carts: description: Whop pixel-attributed add-to-cart events, last-click. type: number call_to_action: description: The call-to-action button shown on the ad. enum: - learn_more - shop_now - sign_up - subscribe - get_started - book_now - apply_now - contact_us - download - order_now - buy_now - get_quote - message_page - whatsapp_message - instagram_message - call_now - get_directions - send_updates - get_offer - watch_more - listen_now - play_game - open_link - no_button - get_offer_view - get_event_tickets - see_menu - request_time - event_rsvp - see_details - view_instagram_profile - null example: learn_more type: - string - 'null' click_through_rate: description: Clicks divided by impressions, between 0 and 1. type: number clicks: description: The number of clicks. type: number completed_registration_value: description: >- USD value attributed to complete-registration events. Sums the value sent with each event, normalized to USD; events without a value contribute 0. type: number completed_registrations: description: Whop pixel-attributed complete-registration events, last-click. type: number contact_value: description: >- USD value attributed to contact events. Sums the value sent with each event, normalized to USD; events without a value contribute 0. type: number contacts: description: Whop pixel-attributed contact events, last-click. type: number cost_per_added_to_cart: description: >- Spend divided by attributed add-to-cart events; null when they are not the goal and none are attributed. type: - number - 'null' cost_per_click: description: Spend divided by clicks; 0 when there are no clicks. type: number cost_per_completed_registration: description: >- Spend divided by attributed complete-registration events; null when they are not the goal and none are attributed. type: - number - 'null' cost_per_contact: description: >- Spend divided by attributed contact events; null when contacts are not the goal and none are attributed. type: - number - 'null' cost_per_lead: description: >- Spend divided by attributed leads; null when leads are not a goal and none are attributed. type: - number - 'null' cost_per_mille: description: Spend per 1,000 impressions; 0 when there are no impressions. type: number cost_per_purchase: description: >- Spend divided by attributed purchases; null when purchases are not a goal and none are attributed. type: - number - 'null' cost_per_result: description: >- Spend divided by Whop pixel-attributed results; null when nothing Whop-attributable is being optimized for. type: - number - 'null' cost_per_schedule: description: >- Spend divided by attributed schedule events; null when schedules are not the goal and none are attributed. type: - number - 'null' cost_per_submitted_application: description: >- Spend divided by attributed submit-application events; null when they are not the goal and none are attributed. type: - number - 'null' cost_per_unique_click: description: >- Spend divided by unique clicks; null when there are no unique clicks. type: - number - 'null' cost_per_viewed_content: description: >- Spend divided by attributed view-content events; null when they are not the goal and none are attributed. type: - number - 'null' created_at: description: When the ad was created, as an ISO 8601 timestamp. type: string creatives: items: $ref: '#/components/schemas/AdCreative' description: >- The creative assets used by this ad. The original asset has a null format; square, vertical, and horizontal entries are placement-specific variants. A carousel ad returns one format-null entry per attachment, in order. type: array custom_conversions: description: >- Whop pixel-attributed custom (merchant-defined) conversion events, last-click, across all custom event names. type: number custom_event_counts: description: >- Whop pixel-attributed custom conversions, keyed by your event name with its last-click count as the value. Empty when no named custom events are attributed. Custom events fired without a name are counted in custom_conversions but omitted here, so these values sum to at most custom_conversions. type: object custom_event_values: description: >- Conversion value attributed to each custom event, keyed by event name like custom_event_counts. Sums the value passed to whop.track, normalized to USD; events fired without a value contribute 0. type: object delivery_status: description: >- Whether the ad is delivering right now, and if not, why. When several states apply at once, the highest-precedence one is returned. enum: - rejected - in_review - draft - campaign_paused - ad_group_paused - paused - processing - issues - learning_limited - learning - active example: rejected type: string descriptions: items: description: The description variants shown on the ad. type: string type: array frequency: description: Platform-reported impressions divided by reach. type: - number - 'null' headlines: items: description: The headline variants shown on the ad. type: string type: array id: description: Unique identifier for the ad, prefixed `ad_`. type: string impressions: description: The number of impressions. type: number issues: items: $ref: '#/components/schemas/AdPlatformIssue' description: Open issues affecting this ad. Empty when there are none. type: array lead_form: description: >- The instant lead form shown when someone taps this ad. `null` when the ad group's conversion_location is not an instant-form destination. oneOf: - $ref: '#/components/schemas/AdLeadForm' - type: 'null' lead_form_id: description: >- The ad platform's ID for the instant form the ad uses. Set when the ad references an existing form via `lead_form_id`, or once a form built from `lead_form` has been created on the platform. type: - string - 'null' lead_value: description: >- USD value attributed to lead events. Sums the value sent with each event, normalized to USD; events without a value contribute 0. type: number leads: description: Whop pixel-attributed leads, last-click. type: number messaging_config: description: >- Welcome message for click-to-message ads, shown when the conversation opens. `null` when the ad has none. oneOf: - $ref: '#/components/schemas/AdMessagingConfig' - type: 'null' multi_advertiser_ads: description: >- Whether the ad can appear alongside other advertisers' ads in the same unit. Defaults to true. type: boolean post_id: description: >- The existing post this ad promotes — a Facebook post or Instagram media ID. `null` when the ad uses uploaded creatives. type: - string - 'null' post_source: description: >- Which network `post_id` refers to: `facebook` (a page post) or `instagram` (a media ID). `null` when the ad uses uploaded creatives. enum: - facebook - instagram - null example: facebook type: - string - 'null' post_thumbnail_url: description: >- Preview image of the existing post this ad promotes. `null` for ads that use uploaded creatives, or until the post's media has been fetched from the network. type: - string - 'null' primary_texts: items: description: The primary text variants shown in the ad body. type: string type: array purchase_value: description: USD value of pixel-attributed purchases. type: number purchases: description: Whop pixel-attributed purchases, last-click. type: number reach: description: The number of unique people who saw this. type: number result_event: description: >- The Whop pixel conversion event whose attributed count represents results — the optimization goal, or the highest-volume attributed event for campaigns that budget per ad group. Null when the goal isn't a Whop-attributed event. enum: - purchase - lead - schedule - submit_application - contact - complete_registration - view_content - add_to_cart - custom - null example: purchase type: - string - 'null' result_event_name: description: >- The merchant-defined event name when result_event is custom; null for the standard events. type: - string - 'null' results: description: >- The Whop pixel-attributed count behind result_event. When a campaign's ad groups optimize different goals there is no single result_event (it is null), and this is instead the sum of each ad group's own attributed results. Null when nothing Whop-attributable is being optimized for. type: - number - 'null' return_on_ad_spend: description: >- Purchase value divided by spend, both in USD (a currency-neutral ratio); 0 when there is no spend. type: number schedule_value: description: >- USD value attributed to schedule events. Sums the value sent with each event, normalized to USD; events without a value contribute 0. type: number schedules: description: Whop pixel-attributed schedule events, last-click. type: number social_accounts: items: $ref: '#/components/schemas/AdEntityReference' description: >- The social accounts the ad runs under — its Facebook page and Instagram profile — each referenced by ID, prefixed `sacc_`. type: array spend: description: The amount charged, in spend_currency. type: number spend_currency: description: The ISO 4217 currency code of all monetary metrics. type: - string - 'null' status: description: >- Whether the ad is enabled. `active` and `paused` are set by you; `in_review` and `rejected` come from ad review. enum: - active - paused - in_review - rejected example: active type: string submitted_application_value: description: >- USD value attributed to submit-application events. Sums the value sent with each event, normalized to USD; events without a value contribute 0. type: number submitted_applications: description: Whop pixel-attributed submit-application events, last-click. type: number title: description: Display title of the ad. type: - string - 'null' unique_click_through_rate: description: Unique clicks divided by impressions, between 0 and 1. type: - number - 'null' unique_clicks: description: >- People who clicked, reported by the Whop pixel, counted once per person. type: number updated_at: description: When the ad was last updated, as an ISO 8601 timestamp. type: string url: description: The URL the ad links to. type: - string - 'null' url_parameters: description: Query parameters appended to the URL, keyed by parameter name. type: object viewed_content_value: description: >- USD value attributed to view-content events. Sums the value sent with each event, normalized to USD; events without a value contribute 0. type: number viewed_contents: description: Whop pixel-attributed view-content events, last-click. type: number required: - click_through_rate - clicks - cost_per_click - cost_per_unique_click - cost_per_lead - cost_per_mille - cost_per_purchase - cost_per_schedule - cost_per_submitted_application - cost_per_contact - cost_per_completed_registration - cost_per_viewed_content - cost_per_added_to_cart - cost_per_result - frequency - impressions - leads - purchase_value - purchases - reach - result_event - result_event_name - results - return_on_ad_spend - spend - spend_currency - unique_click_through_rate - unique_clicks - schedules - submitted_applications - contacts - completed_registrations - viewed_contents - added_to_carts - custom_conversions - custom_event_counts - custom_event_values - lead_value - schedule_value - submitted_application_value - contact_value - completed_registration_value - viewed_content_value - added_to_cart_value - id - title - status - delivery_status - primary_texts - headlines - descriptions - call_to_action - url - url_parameters - post_id - post_source - post_thumbnail_url - messaging_config - multi_advertiser_ads - ad_group - ad_campaign - creatives - lead_form - lead_form_id - social_accounts - created_at - updated_at - issues type: object AdEntityReference: properties: id: description: The referenced entity's id. type: string required: - id type: object AdCreative: properties: crop: description: >- The saved crop window for this creative, in source image pixels. Null for the original asset or a format that has not been cropped. oneOf: - $ref: '#/components/schemas/AdCreativeCrop' - type: 'null' format: description: >- The placement variant this asset covers, or null for the original asset. enum: - square - vertical - horizontal - null example: square type: - string - 'null' id: description: The creative attachment's file id. type: string media_type: description: The kind of asset, image or video. type: - string - 'null' url: description: CDN url of the asset. type: - string - 'null' required: - id - format - url - media_type - crop type: object AdPlatformIssue: properties: id: description: Unique identifier for the issue. type: string message: description: A description of what the issue is and how it can be resolved. type: string resource_id: description: The ID of the campaign, ad group, or ad the issue is attached to. type: - string - 'null' resource_type: description: The type of resource the issue is attached to. enum: - ad_campaign - ad_group - ad example: ad_campaign type: string required: - id - message - resource_id - resource_type type: object AdLeadForm: properties: completion: description: >- Screen shown after the form is submitted. `null` when the form uses the default. oneOf: - $ref: '#/components/schemas/AdLeadFormCompletion' - type: 'null' disclaimer: description: >- Custom consent disclaimer shown before submission. `null` when the form has none. oneOf: - $ref: '#/components/schemas/AdLeadFormDisclaimer' - type: 'null' form_type: description: >- `more_volume` is quickest to submit; `higher_intent` adds a confirmation step before submission. enum: - more_volume - higher_intent example: more_volume type: string intro: description: >- Intro screen shown before the questions. `null` when the form has none. oneOf: - $ref: '#/components/schemas/AdLeadFormIntro' - type: 'null' name: description: Internal name of the form. type: - string - 'null' phone_verification: description: Whether the phone number must be verified by SMS before submitting. type: boolean privacy_policy: description: Your privacy policy, linked from the form. `null` when unset. oneOf: - $ref: '#/components/schemas/AdLeadFormPrivacyPolicy' - type: 'null' questions: items: $ref: '#/components/schemas/AdLeadFormQuestion' description: Questions on the form, in order. type: array required: - name - form_type - intro - questions - privacy_policy - completion - disclaimer - phone_verification type: object AdMessagingConfig: properties: keyword: description: Suggested reply the person can tap to start the conversation. type: - string - 'null' message: description: Greeting shown when the conversation opens. type: - string - 'null' required: - message - keyword type: object V1ErrorResponse: properties: error: properties: message: description: Human-readable error message. type: string type: description: Machine-readable error code. type: string required: - type - message type: object required: - error type: object AdCreativeCrop: properties: height: description: Height of the crop window in source pixels. type: number width: description: Width of the crop window in source pixels. type: number x: description: Left edge of the crop window in source pixels. type: number 'y': description: Top edge of the crop window in source pixels. type: number required: - x - 'y' - width - height type: object AdLeadFormCompletion: properties: button_text: description: Text of the follow-up button. type: - string - 'null' description: description: Body text under the headline. type: - string - 'null' headline: description: Headline of the completion screen. type: - string - 'null' url: description: >- Website the follow-up button opens. `null` when the screen has no button. type: - string - 'null' required: - headline - description - button_text - url type: object AdLeadFormDisclaimer: properties: body: description: Disclaimer text. type: - string - 'null' checkboxes: items: $ref: '#/components/schemas/AdLeadFormDisclaimerCheckbox' description: >- Consent checkboxes the person can tick. Empty when the disclaimer is text-only. type: array title: description: Disclaimer title. type: - string - 'null' required: - title - body - checkboxes type: object AdLeadFormIntro: properties: description: description: Body text under the headline. type: - string - 'null' headline: description: Headline of the intro screen. type: - string - 'null' required: - headline - description type: object AdLeadFormPrivacyPolicy: properties: link_text: description: Link text shown for the policy. `null` uses the platform default. type: - string - 'null' url: description: URL of your privacy policy. type: string required: - url - link_text type: object AdLeadFormQuestion: properties: format: description: >- Answer format for `custom` questions: `short_answer`, `multiple_choice`, or `appointment`. Absent otherwise. type: string label: description: >- Question text for `custom` questions. Absent for standard prefill questions. type: string options: items: $ref: '#/components/schemas/AdLeadFormQuestionOption' description: Choices for `multiple_choice` questions. Absent for other formats. type: array type: description: >- Question type: a standard prefill type such as `email`, `phone`, or `full_name`, or `custom` for your own question. type: string required: - type type: object AdLeadFormDisclaimerCheckbox: properties: checked_by_default: description: Whether the checkbox starts ticked. type: - boolean - 'null' key: description: Stable identifier consent responses are stored under. type: - string - 'null' required: description: Whether the checkbox must be ticked to submit the form. type: - boolean - 'null' text: description: Consent text next to the checkbox. type: string required: - text - key - required - checked_by_default type: object AdLeadFormQuestionOption: properties: key: description: >- Stable identifier the choice's answers are stored under. Absent for simple choices. type: - string - 'null' logic: $ref: '#/components/schemas/AdLeadFormOptionLogic' description: >- Where the form goes when this choice is selected. Absent when the form just continues to the next question. value: description: Choice text shown to the person. type: string required: - value type: object AdLeadFormOptionLogic: properties: action: description: What happens when the choice is selected. enum: - go_to_question - submit_form - close_form example: go_to_question type: string target_end_page_index: description: Zero-based index of the ending screen to jump to. type: number target_question_index: description: Zero-based index of the question to jump to, for `go_to_question`. type: number required: - action type: object responses: InvalidParameters: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Invalid Parameters NotFound: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Resource not found securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer type: http ````