Create the Get Promotion BO API Workflow Input Schema Action
Create a custom action that gets the required structure (schema) for a promotion business object (BO) API workflow.
Required Editions
Available in: Lightning Experience Available in: Agentforce 1, Einstein 1, Enterprise and Unlimited Editions with Consumer Goods Cloud Retail Execution and Agentforce for Consumer Goods Cloud add-on licenses |
| User Permissions Needed | |
|---|---|
| To create custom agent actions for TPM Agent: | View Setup and Configuration |
- From Setup, in the Quick Find box, enter Agentforce Assets, and then select Agentforce Assets.
- Click Actions.
- Click New Agent Action.
- From the Reference Action Type dropdown, select Apex.
- From the Reference Action Category dropdown, select Invocable Method.
- From the Reference Action dropdown, select Get BO API Workflow Schema.
-
Enter
Get Promotion BO API Workflow Input Schemafor the Agent Action Label field andGet_Promotion_BO_API_Workflow_Input_Schemafor the Agent Action API Name field. - Click Next.
-
Configure the action's instructions and variables:
- In the Agent Action Instructions field, enter Retrieves the schema of the Promotion JSON object for the given BO API Workflow.
- In the Loading Text field, enter Working...
-
Under Input, for workflowActionName:
- In the Instructions field, enter Promotion BO API Workflow name to get the schema for.
- Select the Require Input checkbox.
- Clear the Collect data from user checkbox.
-
Under Output, for schema:
- In the Instructions field, enter Schema for BO API Workflow. PromotionJSON payload must adhere to this schema.
- Clear the Filter from Agent Action and Show in conversation checkboxes.
- From the Output Rendering dropdown, select @apexClassType/cgcloud__c__TPM_BOAPI_GetPromotionSchema$SchemaDefinition.
- Click Finish.
Did this article solve your issue?
Let us know so we can improve!

