Incentives tools

An operation tool runs one API operation and takes its variables, so the operation's page says what each accepts. Two differences: the server fills in workspaceId and updatedBy, and campaignId, partnerId, formId, discountCodeId, socialNetworkId, waitlistId, incentiveId, channelId also take the record's name. A task tool chains several operations and is described here in full. Every tool's input schema, keyed by tool name: incentives.schema.json.

Operation tools

Tool	Operation	Access	Toolset	Hints	What it does
create_incentive	CreateIncentive	Write	incentives		Create an incentive with its rules: what a customer earns and when.
decline_incentive_grant	DeclineIncentiveGrant	Write	incentives	destructive	Decline a held incentive grant. Irreversible.
delete_incentive	DeleteIncentive	Write	incentives	destructive	Delete an incentive. Irreversible.
get_incentive	IncentiveDetail	Read	incentives	read-only, idempotent	Get one incentive by id with its rules, grants and limits.
get_incentive_kinds	IncentiveKinds	Read	incentives	read-only, idempotent	List incentive kinds (discount code, gift card, free product and so on) and the fields each needs.
get_incentive_rule_unresolved_recipient_count	IncentiveRuleUnresolvedRecipientCount	Read	incentives	read-only, idempotent	How many recipients of one incentive rule could not be resolved to a customer.
list_incentives	IncentivesList	Read	incentives	read-only, idempotent	List incentives with their rules, grant counts, redemptions and estimated value.
get_incentive_trust	IncentiveTrust	Read	incentives	read-only, idempotent	One incentive's minimum trust score and the grants it held back.
release_incentive_grant	ReleaseIncentiveGrant	Write	incentives		Release a held grant so it is issued to the customer.
replace_incentive_rules	ReplaceIncentiveRules	Write	incentives	destructive	Replace an incentive's rules; the old ones are not kept. Irreversible.
get_response_trust_floor	ResponseTrustFloor	Read	incentives	read-only, idempotent	The minimum trust score of the incentives attached to one form.
update_incentive	UpdateIncentive	Write	incentives		Update an incentive's name, audience, limits, status or trust floor.