> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # BulkGetActionDynamicOutputSchemas # Package: actions # Namespace: ActionCatalogService # Method link: https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-catalog/bulk-get-action-dynamic-output-schemas.md ## Permission Scopes: Set Up Automations: SCOPE.CRM.SETUP-AUTOMATIONS ## Introduction Retrieves dynamic output schemas for multiple actions in a single request. To retrieve the dynamic output schema for a single action, call [Get Action Dynamic Output Schema](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-catalog/get-action-dynamic-output-schema.md). --- ## REST API ### Schema ``` Method: bulkGetActionDynamicOutputSchemas Description: Retrieves dynamic output schemas for multiple actions in a single request. To retrieve the dynamic output schema for a single action, call [Get Action Dynamic Output Schema](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-catalog/get-action-dynamic-output-schema.md). URL: https://www.wixapis.com/v1/actions/bulk/dynamic-output-schema Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: actionsInputMappings Method parameters: param name: actionsInputMappings | type: array | description: List of actions to retrieve dynamic output schemas for. | required: true | validation: minItems 1, maxItems 20 - name: appId | type: string | description: GUID of the app that defines the action. | validation: format GUID - name: actionKey | type: string | description: Action key. Learn about [adding an action to your app](https://dev.wix.com/docs/api-reference/business-management/automations/actions/add-an-action-to-your-app.md). | validation: minLength 5, maxLength 50 - name: actionId | type: string | description: Identifier for the action in the automation. Used to match each output schema to its corresponding action in the response. | validation: format GUID - name: inputMapping | type: object | description: Action input mapping as defined in the [action's input schema](https://dev.wix.com/docs/api-reference/business-management/automations/actions/the-action-input-schema.md). The input mapping must include all parameters specified in the action's input schema's `required` array, and can include any other parameters from the schema. Return type: BulkGetActionDynamicOutputSchemasResponse - name: results | type: array | description: Retrieved dynamic output schemas, one per requested action. - name: itemMetadata | type: ItemMetadata | description: Item metadata. - name: id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). | validation: format GUID - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. - name: error | type: ApplicationError | description: Details about the error in case of failure. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: outputSchema | type: object | description: A [JSON schema](https://json-schema.org/) containing the action's output schema. - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata. - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. - name: totalFailures | type: integer | description: Number of items that couldn't be processed. - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. ``` ### Examples ### Bulk get action dynamic output schemas ```curl curl -X POST 'https://www.wixapis.com/v1/actions/bulk/dynamic-output-schema' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "actionsInputMappings": [ { "appId": "e4c3e640-0b63-4bd9-8574-53f8c14e0236", "actionKey": "send-gift-card", "actionId": "c1d2e3f4-a5b6-7890-cdef-1234567890ab", "inputMapping": { "contactId": "{{var(\"contact.id\")}}", "amount": 50 } }, { "appId": "e4c3e640-0b63-4bd9-8574-53f8c14e0236", "actionKey": "send-email-notification", "actionId": "d2e3f4a5-b6c7-8901-def0-234567890abc", "inputMapping": { "recipientEmail": "{{var(\"contact.email\")}}" } } ] }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.actions.ActionCatalogService.bulkGetActionDynamicOutputSchemas(actionsInputMappings) Description: Retrieves dynamic output schemas for multiple actions in a single request. To retrieve the dynamic output schema for a single action, call [Get Action Dynamic Output Schema](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-catalog/get-action-dynamic-output-schema.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: actionsInputMappings Method parameters: param name: actionsInputMappings | type: array | description: List of actions to retrieve dynamic output schemas for. | required: true | validation: minItems 1, maxItems 20 - name: appId | type: string | description: GUID of the app that defines the action. | validation: format GUID - name: actionKey | type: string | description: Action key. Learn about [adding an action to your app](https://dev.wix.com/docs/api-reference/business-management/automations/actions/add-an-action-to-your-app.md). | validation: minLength 5, maxLength 50 - name: actionId | type: string | description: Identifier for the action in the automation. Used to match each output schema to its corresponding action in the response. | validation: format GUID - name: inputMapping | type: object | description: Action input mapping as defined in the [action's input schema](https://dev.wix.com/docs/api-reference/business-management/automations/actions/the-action-input-schema.md). The input mapping must include all parameters specified in the action's input schema's `required` array, and can include any other parameters from the schema. Return type: PROMISE - name: results | type: array | description: Retrieved dynamic output schemas, one per requested action. - name: itemMetadata | type: ItemMetadata | description: Item metadata. - name: _id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). | validation: format GUID - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. - name: error | type: ApplicationError | description: Details about the error in case of failure. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: outputSchema | type: object | description: A [JSON schema](https://json-schema.org/) containing the action's output schema. - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata. - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. - name: totalFailures | type: integer | description: Number of items that couldn't be processed. - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. ``` ### Examples ### Bulk get action dynamic output schemas Retrieves dynamic output schemas for multiple actions in a single request. ```javascript import { actionCatalog } from "@wix/automations"; async function bulkGetActionDynamicOutputSchemas() { const response = await actionCatalog.bulkGetActionDynamicOutputSchemas({ actionsInputMappings: [ { appId: "e4c3e640-0b63-4bd9-8574-53f8c14e0236", actionKey: "send-gift-card", actionId: "c1d2e3f4-a5b6-7890-cdef-1234567890ab", inputMapping: { contactId: "{{var(\"contact.id\")}}", amount: 50, }, }, { appId: "e4c3e640-0b63-4bd9-8574-53f8c14e0236", actionKey: "send-email-notification", actionId: "d2e3f4a5-b6c7-8901-def0-234567890abc", inputMapping: { recipientEmail: "{{var(\"contact.email\")}}", }, }, ], }); return response; } /* Promise resolves to: * { * "results": [ * { * "itemMetadata": { "id": "c1d2e3f4-a5b6-7890-cdef-1234567890ab", "success": true }, * "outputSchema": { * "$schema": "http://json-schema.org/draft-07/schema", * "type": "object", * "properties": { * "giftCardId": { "type": "string", "format": "uuid", "title": "Gift Card ID" } * } * } * }, * { * "itemMetadata": { "id": "d2e3f4a5-b6c7-8901-def0-234567890abc", "success": true }, * "outputSchema": { ... } * } * ], * "bulkActionMetadata": { "totalSuccesses": 2, "totalFailures": 0 } * } */ ``` ### bulkGetActionDynamicOutputSchemas (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { actionCatalog } from '@wix/automations'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { actionCatalog }, // Include the auth strategy and host as relevant }); async function bulkGetActionDynamicOutputSchemas(actionsInputMappings) { const response = await myWixClient.actionCatalog.bulkGetActionDynamicOutputSchemas(actionsInputMappings); }; ``` ---