Ads

Check a partnership ad code

Checks a creator's partnership ad code for the selected brand identity: through Meta's Advertisable Content API, or — when that lookup returns nothing for the app — by building a creative from the code on the ad account, reading back which post it promotes and deleting it again (no ad is created, nothing is scheduled, nothing bills). Reports whether Meta permits the boost, whether the post is the picked video (postMatch), and a preview thumbnail when only the customer can confirm the post.

post/integrations/ads/meta/boost/eligibility

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/integrations/ads/meta/boost/eligibility
  • Auth: API key in header x-api-key

Request body

adAccountIdstring required
brandPageIdstring required
platform'instagram' | 'facebook' required
platformVideoIdstring required
adCodestring

Response

OK

eligibleboolean required
eligibilitystring nullable required
permissionStatusstring nullable required
contentIdstring nullable required
permalinkstring nullable required
authorDisplayNamestring nullable required
matchesVideoboolean required
reasonstring nullable required
consent'ad_code' | 'account_permission' nullable required
lookup'found' | 'empty' | 'unavailable' nullable required
verification'content_lookup' | 'creative_dry_run' nullable required
postMatch'confirmed' | 'unconfirmed' | 'mismatch' nullable required
previewThumbnailUrlstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.