Social Perks

{'type': 'object', 'required': ['businessId', 'name', 'actions', 'discountValue', 'discountType'], 'properties': {'name': {'type': 'string', 'maxLength': 200, 'description': 'Customer-facing campaign name'}, 'actions': {'type': 'array', 'items': {'type': 'string'}, 'minItems': 1, 'description': "Action IDs the campaign accepts (e.g. ['ig_st'] for an Instagram Story Tag)."}, 'businessId': {'type': 'string', 'description': "The business owning this campaign. Must match the API key's business."}, 'description': {'type': 'string', 'description': 'Optional internal description'}, 'discountType': {'enum': ['pct', 'dol'], 'type': 'string', 'description': "Discount denomination: 'pct' for percentage, 'dol' for dollars off."}, 'discountValue': {'type': 'number', 'minimum': 0.01, 'description': 'Discount amount. Capped at 100 for pct, 10000 for dol.'}, 'expiresInDays': {'type': 'integer', 'maximum': 365, 'minimum': 1, 'description': 'Days until the campaign auto-expires. Default 60.'}, 'maxCompletions': {'type': ['integer', 'null'], 'description': 'Optional cap on total completions. Null = no cap.'}}}

{'type': 'object', 'properties': {'businessType': {'type': 'string', 'description': "Industry name or slug (e.g. 'restaurants', 'coffee-shops'). Omit for the full catalog."}}}

{'type': 'object', 'required': ['campaignId'], 'properties': {'campaignId': {'type': 'string', 'description': 'Campaign to fetch stats for.'}}}

{'type': 'object', 'properties': {'actionId': {'type': 'string', 'description': 'Action ID (e.g. ig_post, google_review)'}, 'platformId': {'type': 'string', 'description': 'Platform ID (e.g. instagram, google)'}, 'businessType': {'type': 'string', 'description': 'Business type modifier (default: general)'}}}

{'type': 'object', 'properties': {'page': {'type': 'integer', 'default': 1}, 'type': {'enum': ['content', 'review', 'engage', 'share', 'referral'], 'type': 'string'}, 'perPage': {'type': 'integer', 'default': 50}, 'maxEffort': {'type': 'integer', 'maximum': 5, 'minimum': 0}, 'platformId': {'type': 'string'}}}

{'type': 'object', 'properties': {'status': {'enum': ['draft', 'active', 'paused', 'completed'], 'type': 'string'}}}

{'type': 'object', 'properties': {'page': {'type': 'integer', 'default': 1, 'minimum': 1}, 'state': {'enum': ['pending', 'approved', 'rejected'], 'type': 'string'}, 'perPage': {'type': 'integer', 'default': 25, 'maximum': 100, 'minimum': 1}, 'businessId': {'type': 'string'}, 'campaignId': {'type': 'string'}}}

{'type': 'object', 'required': ['submissionId', 'decision'], 'properties': {'reason': {'type': 'string', 'maxLength': 500, 'description': "Required when decision='reject'. 1-500 chars."}, 'decision': {'enum': ['approve', 'reject'], 'type': 'string', 'description': 'Approve releases the perk. Reject explains why the proof was insufficient.'}, 'submissionId': {'type': 'string', 'description': 'Submission id from a prior submitProof call.'}}}

{'type': 'object', 'properties': {'platform': {'type': 'string'}, 'minFollowers': {'type': 'integer'}}}

{'type': 'object', 'required': ['campaignId', 'actionId', 'proofUrl', 'proofType'], 'properties': {'actionId': {'type': 'string', 'description': 'Specific action being completed (must be allowed by the campaign).'}, 'metadata': {'type': 'object', 'description': 'Optional bag of context (poster handle, post timestamp, etc.).', 'additionalProperties': True}, 'proofUrl': {'type': 'string', 'maxLength': 2048, 'description': 'Public URL of the proof. For url-type submissions, the platform verifier will fetch this.'}, 'proofType': {'enum': ['screenshot', 'url', 'video', 'api_verified'], 'type': 'string', 'description': "How the proof was captured. 'url' triggers automated verification."}, 'campaignId': {'type': 'string', 'description': 'Campaign the submission applies to.'}}}