---
title: "Automation Workflow API"
url: "https://earlyaccess.developers.bynder.com/apis/automation-workflow-api-1/versions/428d2b99-ec99-455a-8d22-c0d61a9bb810"
---

# Automation Workflow API

OpenAPI specification document.

```json
{"components":{"schemas":{"AndCondition":{"properties":{"and":{"items":{"$ref":"#/components/schemas/LeafCondition"},"type":"array"}},"title":"AndCondition","type":"object"},"ArchiveTerm":{"properties":{"offset_amount":{"format":"int32","type":"integer"},"offset_unit":{"type":"string"}},"required":["offset_amount","offset_unit"],"title":"ArchiveTerm","type":"object"},"AssetTypeTerm":{"properties":{"asset_type":{"type":"string"}},"required":["asset_type"],"title":"AssetTypeTerm","type":"object"},"AutomationWorkflowAction":{"properties":{"action_type":{"type":"string"}},"required":["action_type"],"title":"AutomationWorkflowAction","type":"object"},"AutomationWorkflowActionsResponse":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/AutomationWorkflowAction"},"type":"array"},"max_actions_limit":{"format":"int32","type":"integer"}},"required":["max_actions_limit"],"title":"AutomationWorkflowActionsResponse","type":"object"},"AutomationWorkflowCondition":{"properties":{"name":{"type":"string"},"operators":{"items":{"type":"string"},"type":"array"},"terms":{"items":{"$ref":"#/components/schemas/Term"},"type":"array"}},"required":["name"],"title":"AutomationWorkflowCondition","type":"object"},"AutomationWorkflowConditionsResponse":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/AutomationWorkflowCondition"},"type":"array"},"max_conditions_count":{"format":"int32","type":"integer"}},"required":["max_conditions_count"],"title":"AutomationWorkflowConditionsResponse","type":"object"},"AutomationWorkflowResponse":{"properties":{"created_by_id":{"type":"string"},"date_created":{"type":"string"},"id":{"type":"string"},"is_valid":{"type":"boolean"},"name":{"type":"string"},"status":{"type":"string"},"steps":{"items":{"$ref":"#/components/schemas/AutomationWorkflowStep"},"type":"array"},"triggers":{"items":{"type":"string"},"type":"array"}},"required":["id","status","name","created_by_id","date_created","is_valid"],"title":"AutomationWorkflowResponse","type":"object"},"AutomationWorkflowRuleBody":{"properties":{"name":{"type":"string"},"steps":{"items":{"$ref":"#/components/schemas/AutomationWorkflowStep"},"type":"array"},"triggers":{"items":{"type":"string"},"type":"array"}},"required":["name"],"title":"AutomationWorkflowRuleBody","type":"object"},"AutomationWorkflowStep":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/AutomationWorkflowStepActionBase"},"type":"array"},"conditions":{"items":{"$ref":"#/components/schemas/AndCondition"},"type":"array"},"step_triggers":{"items":{"type":"string"},"type":"array"}},"title":"AutomationWorkflowStep","type":"object"},"AutomationWorkflowStepActionAgent":{"properties":{"action_type":{"type":"string"},"data":{"$ref":"#/components/schemas/StepActionAgentData"},"is_valid":{"type":"boolean"}},"required":["action_type","data"],"title":"AutomationWorkflowStepActionAgent","type":"object"},"AutomationWorkflowStepActionBase":{"oneOf":[{"$ref":"#/components/schemas/AutomationWorkflowStepActionAgent"},{"$ref":"#/components/schemas/AutomationWorkflowStepAddToCollectionAction"}],"title":"AutomationWorkflowStepActionBase"},"AutomationWorkflowStepAddToCollectionAction":{"properties":{"action_type":{"type":"string"},"data":{"$ref":"#/components/schemas/StepAddToCollectionActionData"},"is_valid":{"type":"boolean"}},"required":["action_type","data"],"title":"AutomationWorkflowStepAddToCollectionAction","type":"object"},"AutomationWorkflowTrigger":{"properties":{"name":{"type":"string"}},"required":["name"],"title":"AutomationWorkflowTrigger","type":"object"},"AutomationWorkflowTriggersResponse":{"properties":{"triggers":{"items":{"$ref":"#/components/schemas/AutomationWorkflowTrigger"},"type":"array"}},"title":"AutomationWorkflowTriggersResponse","type":"object"},"CreateAutomationWorkflowRuleResponse":{"properties":{"account_id":{"type":"string"},"created_by_id":{"type":"string"},"date_created":{"type":"string"},"date_modified":{"type":"string"},"edited_by_id":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"}},"required":["id","status","name","account_id","created_by_id","date_created","date_modified"],"title":"CreateAutomationWorkflowRuleResponse","type":"object"},"EditAutomationWorkflowRuleBody":{"properties":{"name":{"type":"string"},"steps":{"items":{"$ref":"#/components/schemas/AutomationWorkflowStep"},"type":"array"},"triggers":{"items":{"type":"string"},"type":"array"}},"title":"EditAutomationWorkflowRuleBody","type":"object"},"ErrorAuthorizationResponse":{"properties":{"message":{"type":"string"}},"required":["message"],"title":"ErrorAuthorizationResponse","type":"object"},"ErrorResponse":{"properties":{"message":{"type":"string"}},"required":["message"],"title":"ErrorResponse","type":"object"},"ErrorResponseNotFound":{"properties":{"message":{"type":"string"}},"required":["message"],"title":"ErrorResponseNotFound","type":"object"},"ErrorResponseRuleAlreadyPaused":{"properties":{"message":{"type":"string"}},"required":["message"],"title":"ErrorResponseRuleAlreadyPaused","type":"object"},"ExpressionCondition":{"properties":{"operator":{"type":"string"},"term":{"items":{"$ref":"#/components/schemas/Term"},"type":"array"}},"required":["operator"],"title":"ExpressionCondition","type":"object"},"LeafCondition":{"properties":{"condition_type":{"type":"string"},"expression":{"$ref":"#/components/schemas/ExpressionCondition"},"is_valid":{"type":"boolean"}},"required":["condition_type","expression"],"title":"LeafCondition","type":"object"},"ListAutomationWorkflowRulesResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/MetadataOutput"},"rules":{"items":{"$ref":"#/components/schemas/AutomationWorkflowResponse"},"type":"array"}},"required":["metadata"],"title":"ListAutomationWorkflowRulesResponse","type":"object"},"MetadataOutput":{"properties":{"next_page":{"type":"string"},"previous_page":{"type":"string"}},"title":"MetadataOutput","type":"object"},"MetapropertyOptionTerm":{"properties":{"metaproperty_id":{"format":"uuid","type":"string"},"metaproperty_option_id":{"format":"uuid","type":"string"}},"required":["metaproperty_id"],"title":"MetapropertyOptionTerm","type":"object"},"SingleRuleAutomationWorkflowResponse":{"properties":{"created_by_id":{"type":"string"},"date_created":{"type":"string"},"date_modified":{"type":"string"},"date_removed":{"type":"string"},"edited_by_id":{"type":"string"},"id":{"type":"string"},"is_valid":{"type":"boolean"},"name":{"type":"string"},"status":{"type":"string"},"steps":{"items":{"$ref":"#/components/schemas/AutomationWorkflowStep"},"type":"array"},"triggers":{"items":{"type":"string"},"type":"array"}},"required":["id","status","name","date_created","created_by_id","date_modified","is_valid"],"title":"SingleRuleAutomationWorkflowResponse","type":"object"},"StepActionAgentData":{"properties":{"agent_id":{"type":"string"},"run_name":{"type":"string"}},"required":["agent_id"],"title":"StepActionAgentData","type":"object"},"StepAddToCollectionActionData":{"properties":{"collection_id":{"type":"string"}},"required":["collection_id"],"title":"StepAddToCollectionActionData","type":"object"},"Term":{"oneOf":[{"$ref":"#/components/schemas/ArchiveTerm"},{"$ref":"#/components/schemas/AssetTypeTerm"},{"$ref":"#/components/schemas/MetapropertyOptionTerm"}],"title":"Term"},"UpdateStatusAutomationWorkflowRuleBody":{"properties":{"status":{"type":"string"}},"required":["status"],"title":"UpdateStatusAutomationWorkflowRuleBody","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"\nThis API allows clients to manage automation-workflow rules.\n\n<b>Servers:</b>\n\n1. <b>Local Development:</b>\n   - Base URL: http://localhost:8080/{endpoint}\n\n2. <b>Stage or Production:</b>\n   - Base URL: https://automation-workflow-service.bynder.com/api/1/automation-workflow/{endpoint}\n\nEnsure you're using the correct server depending on the environment you're working in (local or production).\n  ","title":"Automation Workflow API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/actions":{"get":{"description":"\nFetches a list of available automation workflow actions.\n\n<b>Note:</b> Only actions that the authenticated user has permission to use are included in the response.\nFor example, actions requiring specific features or roles may be omitted if the user lacks access.\n        ","operationId":"getActions","responses":{"200":{"content":{"application/json":{"example":{"actions":[{"action_type":"AGENT_ENRICHMENT"},{"action_type":"ADD_TO_COLLECTION"},{"action_type":"AGENT_TRANSFORMATION"},{"action_type":"AGENT_BRAND_COMPLIANCE"},{"action_type":"AGENT_GOVERNANCE"}],"max_actions_limit":5},"schema":{"$ref":"#/components/schemas/AutomationWorkflowActionsResponse"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}},"description":""}},"security":[{},{"httpAuth":[]}],"summary":"Fetches a list of available automation workflow actions.","tags":["Automation Workflow Actions"]}},"/conditions":{"get":{"description":"\nFetches a list of available automation workflow conditions.\n\nSome conditions accept only specific predefined terms, which are included in the response for reference.\n\n<b>Note:</b> The `Archived` condition requires the `RelativeDate` trigger.\n        ","operationId":"getConditions","responses":{"200":{"content":{"application/json":{"example":{"conditions":[{"name":"AssetType","operators":["CONTAINS","DOES_NOT_CONTAIN"],"terms":[{"asset_type":"IMAGE"},{"asset_type":"VIDEO"},{"asset_type":"DOCUMENT"},{"asset_type":"AUDIO"},{"asset_type":"3D"}]},{"name":"MetapropertyOption","operators":["CONTAINS","DOES_NOT_CONTAIN","IS_EMPTY","HAS_VALUE","EQUALS"],"terms":[{"metaproperty_id":"00000000-0000-0000-0000-000000000000","metaproperty_option_id":"00000000-0000-0000-0000-000000000000"}]},{"name":"Archived","operators":["STARTS_IN"],"terms":[{"offset_amount":1,"offset_unit":"DAY"},{"offset_amount":2,"offset_unit":"WEEKS"},{"offset_amount":3,"offset_unit":"MONTHS"}]}],"max_conditions_count":5},"schema":{"$ref":"#/components/schemas/AutomationWorkflowConditionsResponse"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}},"description":""}},"security":[{},{"httpAuth":[]}],"summary":"Fetches a list of available automation workflow conditions.","tags":["Automation Workflow Conditions"]}},"/rules":{"get":{"description":"Fetches all automation workflow rules within an account in descending order of creation, with optional pagination (start and limit).","operationId":"getRules","parameters":[{"in":"query","name":"start","required":false,"schema":{"format":"int32","type":"integer"}},{"in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAutomationWorkflowRulesResponse"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}},"description":""}},"security":[{},{"httpAuth":[]}],"summary":"Fetches all automation workflow rules.","tags":["Automation Workflow Rules"]},"post":{"description":"\nCreates a new automation workflow rule. Ensure that you check the available triggers, conditions, and actions to use valid options.\n\nUse the following endpoints to check which options are available before creating a rule:\n- `/triggers` – lists available triggers\n- `/conditions` – lists available conditions\n- `/actions` – lists available actions\n        ","operationId":"postRules","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationWorkflowRuleBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAutomationWorkflowRuleResponse"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}},"description":""}},"security":[{},{"httpAuth":[]}],"summary":"Creates a new automation workflow rule.","tags":["Automation Workflow Rules"]}},"/rules/{ruleId}":{"delete":{"description":"Deletes an automation workflow rule by its ID.","operationId":"deleteRulesRuleid","parameters":[{"in":"path","name":"ruleId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseNotFound"}}},"description":""}},"security":[{},{"httpAuth":[]}],"summary":"Deletes an automation workflow rule.","tags":["Automation Workflow Rules"]},"get":{"description":"Fetches a specific automation workflow rule.","operationId":"getRulesRuleid","parameters":[{"in":"path","name":"ruleId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleRuleAutomationWorkflowResponse"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseNotFound"}}},"description":""}},"security":[{},{"httpAuth":[]}],"summary":"Fetches a specific automation workflow rule.","tags":["Automation Workflow Rules"]},"put":{"description":"Updates an existing automation workflow rule.","operationId":"putRulesRuleid","parameters":[{"in":"path","name":"ruleId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditAutomationWorkflowRuleBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleRuleAutomationWorkflowResponse"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseNotFound"}}},"description":""}},"security":[{},{"httpAuth":[]}],"summary":"Updates an existing automation workflow rule.","tags":["Automation Workflow Rules"]}},"/rules/{ruleId}/status":{"patch":{"description":"Updates the status of an existing automation workflow rule. The status must be one of the following: `PUBLISHED` or `PAUSED`.","operationId":"patchRulesRuleidStatus","parameters":[{"in":"path","name":"ruleId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStatusAutomationWorkflowRuleBody"}}},"required":true},"responses":{"204":{"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseNotFound"}}},"description":""},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseRuleAlreadyPaused"}}},"description":""}},"security":[{},{"httpAuth":[]}],"summary":"Updates the status of an existing automation workflow rule.","tags":["Automation Workflow Rules"]}},"/triggers":{"get":{"description":"\nFetches a list of available automation workflow triggers.\n\n<b>Note:</b> The `RelativeDate` trigger must be used with the `Archived` condition.\n","operationId":"getTriggers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationWorkflowTriggersResponse"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}},"description":""}},"security":[{},{"httpAuth":[]}],"summary":"Fetches a list of available automation workflow triggers.","tags":["Automation Workflow Triggers"]}}},"servers":[{"url":"https://{your-bynder-domain}/api/1/automation-workflow/"}]}
```