# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for ThriveCart Affiliates API version: 1.0.0 extends: openapi/thrivecart-affiliates-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-10-01' generator: build-phrasing.py label: Generated by API Evangelist operations: 10 - target: $.paths['/affiliates'].get update: x-apievangelist-phrasing: intent: Search affiliates by product, name or email effect: read questions: - How do I find affiliates approved to promote a particular product? - Can I look up an affiliate by searching their name or email? - How many affiliates can one page of search results return? instructions: - text: Search affiliates approved for product {product_id}, page {page} with {perPage} per page. slots: product_id: query.product_id page: query.page perPage: query.perPage - text: Find affiliates matching {query}, showing page {page} at {perPage} results per page. slots: query: query.query page: query.page perPage: query.perPage method: generated generated: '2026-10-01' - target: $.paths['/affiliates'].post update: x-apievangelist-phrasing: intent: Create a new affiliate effect: write questions: - How do I sign up a new affiliate and add them to my products? - Can I choose a preferred affiliate ID when I create someone as an affiliate? - Is it possible to auto-approve a brand-new affiliate and skip the welcome emails? instructions: - text: Create a new affiliate with email {email} for products {product_ids}. slots: email: requestBody.email product_ids: requestBody.product_ids - text: 'Add {name} ({email}) as a new affiliate on products {product_ids} and auto-approve them: {auto_approve}.' slots: name: requestBody.name email: requestBody.email product_ids: requestBody.product_ids auto_approve: requestBody.auto_approve - text: Create affiliate {email} for {product_ids}, recorded as referred by {parent_affiliate}. slots: email: requestBody.email product_ids: requestBody.product_ids parent_affiliate: requestBody.parent_affiliate method: generated generated: '2026-10-01' - target: $.paths['/affiliate'].post update: x-apievangelist-phrasing: intent: Look up one affiliate's details effect: read questions: - How can I pull up the details of a single affiliate? - Can I fetch an affiliate's record using just their email address? instructions: - text: Get the affiliate record for {affiliate_id}. slots: affiliate_id: requestBody.affiliate_id - text: Show me everything on file for the affiliate with email or ID {affiliate_id}. slots: affiliate_id: requestBody.affiliate_id method: generated generated: '2026-10-01' - target: $.paths['/affiliates/{affiliate_id}/favorite'].post update: x-apievangelist-phrasing: intent: Mark an affiliate as a favorite effect: write questions: - How do I flag one of my affiliates as a VIP? - Can I star an affiliate as a favorite? instructions: - text: Mark affiliate {affiliate_id} as a favorite. slots: affiliate_id: path.affiliate_id - text: Flag {affiliate_id} as a VIP affiliate. slots: affiliate_id: path.affiliate_id method: generated generated: '2026-10-01' - target: $.paths['/affiliates/{affiliate_id}/unfavorite'].post update: x-apievangelist-phrasing: intent: Remove an affiliate's favorite marker effect: write questions: - How do I take an affiliate off my favorites? - Can I remove the VIP flag from an affiliate? instructions: - text: Unfavorite affiliate {affiliate_id}. slots: affiliate_id: path.affiliate_id - text: Remove the VIP marker from affiliate {affiliate_id}. slots: affiliate_id: path.affiliate_id method: generated generated: '2026-10-01' - target: $.paths['/affiliates/{affiliate_id}/register'].post update: x-apievangelist-phrasing: intent: Register an existing affiliate for products effect: write questions: - How do I add an affiliate I already have to another product? - Can an existing affiliate be enrolled in several products at once? instructions: - text: Register existing affiliate {affiliate_id} for products {product_ids}. slots: affiliate_id: path.affiliate_id product_ids: requestBody.product_ids - text: 'Enroll affiliate {affiliate_id} in {product_ids} and auto-approve: {auto_approve}.' slots: affiliate_id: path.affiliate_id product_ids: requestBody.product_ids auto_approve: requestBody.auto_approve method: generated generated: '2026-10-01' - target: $.paths['/affiliates/{affiliate_id}/approve'].post update: x-apievangelist-phrasing: intent: Approve an affiliate's pending application effect: write questions: - How do I approve an affiliate who applied to promote my product? - What happens if I approve an affiliate whose application isn't pending? instructions: - text: Approve affiliate {affiliate_id}'s pending application for products {product_ids}. slots: affiliate_id: path.affiliate_id product_ids: requestBody.product_ids - text: 'Accept {affiliate_id} for {product_ids} without sending emails: trigger_emails {trigger_emails}.' slots: affiliate_id: path.affiliate_id product_ids: requestBody.product_ids trigger_emails: requestBody.trigger_emails method: generated generated: '2026-10-01' - target: $.paths['/affiliates/{affiliate_id}/reject'].post update: x-apievangelist-phrasing: intent: Reject an affiliate's pending application effect: write questions: - How do I turn down an affiliate's application to promote a product? - Can I decline an affiliate applicant without emailing them? instructions: - text: Reject affiliate {affiliate_id}'s pending application for products {product_ids}. slots: affiliate_id: path.affiliate_id product_ids: requestBody.product_ids - text: Decline {affiliate_id} for {product_ids} and set trigger_emails to {trigger_emails}. slots: affiliate_id: path.affiliate_id product_ids: requestBody.product_ids trigger_emails: requestBody.trigger_emails method: generated generated: '2026-10-01' - target: $.paths['/affiliates/{affiliate_id}/custom_commissions'].post update: x-apievangelist-phrasing: intent: Set custom commissions for an affiliate effect: write questions: - Can I pay one affiliate a different commission on a specific product? - How do I override how much and when an individual affiliate gets paid? - How do I clear custom commissions I set for an affiliate? instructions: - text: Set custom commissions {commission_object} for affiliate {affiliate_id} on product {product_id}. slots: commission_object: requestBody.commission_object affiliate_id: path.affiliate_id product_id: requestBody.product_id - text: Remove the custom commission override for affiliate {affiliate_id} on product {product_id} by sending {commission_object} as null. slots: affiliate_id: path.affiliate_id product_id: requestBody.product_id commission_object: requestBody.commission_object method: generated generated: '2026-10-01' - target: $.paths['/affiliates/{affiliate_id}/delete'].post update: x-apievangelist-phrasing: intent: Delete an affiliate effect: destructive questions: - How do I permanently remove an affiliate from my account? - Can I delete an affiliate user through the API? instructions: - text: Delete affiliate {affiliate_id}. slots: affiliate_id: path.affiliate_id - text: Remove the affiliate user {affiliate_id} from my account. slots: affiliate_id: path.affiliate_id method: generated generated: '2026-10-01'