---
url: "https://earlyaccess.developers.bynder.com/apis/automations-api-1/versions/c7c13882-9e51-4554-bcb8-9517eda44741"
---

OpenAPI specification document.

```json
{"components":{"schemas":{"ActionTypeEnum":{"enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"],"type":"string"},"AttributeValueComponent":{"properties":{"value":{"type":"string"}},"required":["value"],"type":"object"},"Automation":{"properties":{"actionMetaproperties":{"type":"string"},"actionOptions":{"type":"string"},"actionType":{"enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"],"type":"string"},"automationId":{"type":"string"},"conditionType":{"enum":["ALL","ANY","ANY_OPTION"],"type":"string"},"triggerType":{"enum":["SELECTED"],"type":"string"}},"required":["automationId","actionType","conditionType","triggerType"],"type":"object"},"AutomationComponentOutput":{"properties":{"metapropertyId":{"type":"string"},"metapropertyName":{"type":"string"},"metapropertyType":{"type":"string"},"options":{"items":{"properties":{"optionId":{"type":"string"},"optionName":{"type":"string"}},"required":["optionId","optionName"],"type":"object"},"type":"array"},"value":{"type":"string"}},"type":"object"},"AutomationCreateErrorOutput":{"properties":{"errorCode":{"type":"string"},"errors":{"items":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"},"AutomationCreatedOutput":{"properties":{"automationId":{"format":"uuid","type":"string"},"message":{"type":"string"}},"required":["automationId","message"],"type":"object"},"AutomationDeletedOutput":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"AutomationInput":{"properties":{"actionType":{"enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"],"type":"string"},"actionsOn":{"items":{"properties":{"metapropertyId":{"format":"uuid","type":"string"},"optionIds":{"items":{"format":"uuid","type":"string"},"type":"array"},"value":{"type":"string"}},"type":"object"},"type":"array"},"conditionType":{"enum":["ALL","ANY","ANY_OPTION"],"type":"string"},"triggerType":{"enum":["SELECTED"],"type":"string"},"triggersOn":{"items":{"properties":{"metapropertyId":{"format":"uuid","type":"string"},"optionIds":{"items":{"format":"uuid","type":"string"},"type":"array"},"value":{"type":"string"}},"type":"object"},"type":"array"}},"required":["actionType","conditionType","triggerType"],"type":"object"},"AutomationNotFoundOutput":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"},"AutomationUpdateBadRequestOutput":{"properties":{"errorCode":{"type":"string"},"errors":{"items":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"},"AutomationUpdatedOutput":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"Automations":{"properties":{"automations":{"items":{"properties":{"actionMetaproperties":{"type":"string"},"actionOptions":{"type":"string"},"actionType":{"enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"],"type":"string"},"automationId":{"type":"string"},"conditionType":{"enum":["ALL","ANY","ANY_OPTION"],"type":"string"},"triggerType":{"enum":["SELECTED"],"type":"string"}},"required":["automationId","actionType","conditionType","triggerType"],"type":"object"},"type":"array"},"metadata":{"properties":{"nextPage":{"type":"string"}},"required":["nextPage"],"type":"object"}},"type":"object"},"Component":{"properties":{"metapropertyId":{"format":"uuid","type":"string"},"optionIds":{"items":{"format":"uuid","type":"string"},"type":"array"},"value":{"type":"string"}},"type":"object"},"ConditionTypeEnum":{"enum":["ALL","ANY","ANY_OPTION"],"type":"string"},"ConflictingAllConditionOutput":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"},"ConflictingAnyConditionOutput":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"},"DuplicateAutomationOutput":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"},"FullAutomation":{"properties":{"actionType":{"enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"],"type":"string"},"actionsOn":{"items":{"properties":{"metapropertyId":{"type":"string"},"metapropertyName":{"type":"string"},"metapropertyType":{"type":"string"},"options":{"items":{"properties":{"optionId":{"type":"string"},"optionName":{"type":"string"}},"required":["optionId","optionName"],"type":"object"},"type":"array"},"value":{"type":"string"}},"type":"object"},"type":"array"},"automationId":{"type":"string"},"conditionType":{"enum":["ALL","ANY","ANY_OPTION"],"type":"string"},"triggerType":{"enum":["SELECTED"],"type":"string"},"triggersOn":{"items":{"properties":{"metapropertyId":{"type":"string"},"metapropertyName":{"type":"string"},"metapropertyType":{"type":"string"},"options":{"items":{"properties":{"optionId":{"type":"string"},"optionName":{"type":"string"}},"required":["optionId","optionName"],"type":"object"},"type":"array"},"value":{"type":"string"}},"type":"object"},"type":"array"}},"required":["automationId","actionType","conditionType","triggerType"],"type":"object"},"InvalidActionValue":{"properties":{"errorCode":{"type":"string"},"id":{"format":"uuid","type":"string"},"message":{"type":"string"}},"required":["id","errorCode","message"],"type":"object"},"InvalidAutomationOutput":{"properties":{"errorCode":{"type":"string"},"errors":{"items":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"},"type":"array"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"},"InvalidMetapropertyType":{"properties":{"errorCode":{"type":"string"},"id":{"format":"uuid","type":"string"},"message":{"type":"string"},"metapropertyType":{"type":"string"}},"required":["id","metapropertyType","errorCode","message"],"type":"object"},"Metadata":{"properties":{"nextPage":{"type":"string"}},"required":["nextPage"],"type":"object"},"MetapropertyComponent":{"properties":{"metapropertyId":{"format":"uuid","type":"string"}},"required":["metapropertyId"],"type":"object"},"MetapropertyNotFoundOutput":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"},"MetapropertyOption":{"properties":{"optionId":{"type":"string"},"optionName":{"type":"string"}},"required":["optionId","optionName"],"type":"object"},"MetapropertyValueComponent":{"properties":{"metapropertyId":{"format":"uuid","type":"string"},"value":{"type":"string"}},"required":["metapropertyId","value"],"type":"object"},"OptionComponent":{"properties":{"metapropertyId":{"format":"uuid","type":"string"},"optionIds":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["metapropertyId"],"type":"object"},"TaxonomyError":{"properties":{"errorCode":{"type":"string"},"id":{"format":"uuid","type":"string"},"message":{"type":"string"},"metapropertyType":{"type":"string"}},"type":"object"},"TaxonomyErrorOutput":{"properties":{"errorCode":{"type":"string"},"errors":{"items":{"properties":{"errorCode":{"type":"string"},"id":{"format":"uuid","type":"string"},"message":{"type":"string"},"metapropertyType":{"type":"string"}},"type":"object"},"type":"array"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"},"TriggerTypeEnum":{"enum":["SELECTED"],"type":"string"},"UnauthorizedErrorOutput":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"},"UnknownMetaproperty":{"properties":{"errorCode":{"type":"string"},"id":{"format":"uuid","type":"string"},"message":{"type":"string"}},"required":["id","errorCode","message"],"type":"object"},"UnknownOption":{"properties":{"errorCode":{"type":"string"},"id":{"format":"uuid","type":"string"},"message":{"type":"string"}},"required":["id","errorCode","message"],"type":"object"},"ValidationFailureOutput":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"title":"Automations API","version":"1.0"},"openapi":"3.1.0","paths":{"/api/1/automation/automations":{"get":{"description":"Filter automations by metaproperty actions. Requires a `metaproperty_id`, optionally accepts one or more comma separated `option_ids`.","operationId":"getApi1AutomationAutomations","parameters":[{"in":"header","name":"x-api-correlation-id","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return","in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":1000,"minimum":1,"type":"integer"}},{"description":"Starting string for pagination","in":"query","name":"start","required":false,"schema":{"type":"string"}},{"description":"Filter automations by action type","in":"query","name":"actionType","required":false,"schema":{"enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"],"type":"string"}},{"description":"Filter automations by condition type","in":"query","name":"conditionType","required":false,"schema":{"enum":["ALL","ANY","ANY_OPTION"],"type":"string"}},{"description":"Filter automations by actions on metaproperty and optionIds. Format: `metapropertyId` or `metapropertyId`;`optionId`,`optionId`. Ensure to add `;` to separate the `metapropertyId` and the `optionId` when using this filter.","in":"query","name":"actionsOn","required":false,"schema":{"type":"string"}},{"description":"Filter automations by triggers on metaproperty and optionIds. Format: `metapropertyId` or `metapropertyId`;`optionId`,`optionId`. Ensure to add `;` to separate the `metapropertyId` and the `optionId` when using this filter.","in":"query","name":"triggersOn","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"AutomationsExample":{"summary":"An example of a paginated list of automations","value":{"automations":[{"actionMetaproperties":"Asset Sub-Type","actionOptions":"Marketing","actionType":"SHOW_OPTION","automationId":"00000000-0000-0000-0000-000000000000","conditionType":"ANY","triggerType":"SELECTED"}],"metadata":{"nextPage":"/api/1/automation/metaproperties/00000000-0000-0000-0000-000000000000/automations?limit=2&start=00000000-0000-0000-0000-000000000001"}}}},"schema":{"properties":{"automations":{"items":{"properties":{"actionMetaproperties":{"type":"string"},"actionOptions":{"type":"string"},"actionType":{"enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"],"type":"string"},"automationId":{"type":"string"},"conditionType":{"enum":["ALL","ANY","ANY_OPTION"],"type":"string"},"triggerType":{"enum":["SELECTED"],"type":"string"}},"required":["automationId","actionType","conditionType","triggerType"],"type":"object"},"type":"array"},"metadata":{"properties":{"nextPage":{"type":"string"}},"required":["nextPage"],"type":"object"}},"type":"object"}}},"description":""},"401":{"content":{"application/json":{"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"}}},"description":""},"404":{"content":{"application/json":{"examples":{"MetapropertyNotFoundOutput":{"summary":"Response when metaproperty was not found","value":{"errorCode":"metaproperty-not-found","message":"The metaproperty was not found"}}},"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Retrieve automations","tags":["Automations - New taxonomy API"]},"post":{"description":"Create a new automation. Make sure to use one of the supported bodies listed in the cURL request examples. E.g. ShowOptionAll, DenyDownloads, etc.","operationId":"postApi1AutomationAutomations","parameters":[{"in":"header","name":"x-api-correlation-id","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ApplyWatermark":{"description":"Automatically apply watermark to assets when specific metaproperty options are selected.","summary":"Apply watermark automation","value":{"actionType":"SELECT","actionsOn":[{"value":"watermark"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ArchiveAssets":{"description":"Automatically archive assets when specific metaproperty options are selected.","summary":"Archive assets automation","value":{"actionType":"SELECT","actionsOn":[{"value":"archive"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"DenyDownloads":{"description":"Automatically deny downloading of assets when specific metaproperty options are selected.","summary":"Deny asset downloads automation","value":{"actionType":"DESELECT","actionsOn":[{"value":"watermark"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"EmptyMetaproperty":{"description":"Automatically clears the value of a text or date metaproperty when specific conditions are met. This type of automation can only be used with Text and Date metaproperties.","summary":"Empty metaproperty automation","value":{"actionType":"EMPTY","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"MarkAsLimitedUsage":{"description":"Automatically mark assets as limited usage when specific metaproperty options are selected.","summary":"Mark assets as limited usage automation","value":{"actionType":"SELECT","actionsOn":[{"value":"limited"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"PrefillMetaproperty":{"description":"Automatically fills a text or date metaproperty with a predefined value when specific options are selected. This type of automation can only be used with Text and Date metaproperties. Furthermore, the value must be in the correct format - free text for Text metaproperties and DD/MM/YYYY for Date metaproperties.","summary":"Prefill text metaproperty automation","value":{"actionType":"PREFILL","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","value":"text_that_should_be_prefilled"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ShowMetapropertyAnyOption":{"description":"Show metaproperty based on any option selection. Triggers when any option from the specified trigger metaproperty is selected.","summary":"Show metaproperty based on any trigger options","value":{"actionType":"SHOW_METAPROPERTY","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}],"conditionType":"ANY_OPTION","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}]}},"ShowMetapropertySpecificOptions":{"description":"Show metaproperty based on specific option selection. Triggers when any of the specified options from the trigger metaproperty are selected.","summary":"Show metaproperty based on specific trigger options","value":{"actionType":"SHOW_METAPROPERTY","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ShowOptionAll":{"description":"Show specific options based on multiple trigger option selection. Automation will apply if all the triggering options are selected.","summary":"Show options with ALL condition","value":{"actionType":"SHOW_OPTION","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}],"conditionType":"ALL","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000001","optionIds":["00000000-0000-0000-0000-000000000001"]},{"metapropertyId":"00000000-0000-0000-0000-000000000002","optionIds":["00000000-0000-0000-0000-000000000002"]}]}},"ShowOptionAny":{"description":"Show specific options based on trigger option selection. Automation will apply if any of the triggering options is selected.","summary":"Show options with any specific options","value":{"actionType":"SHOW_OPTION","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}}},"schema":{"properties":{"actionType":{"enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"],"type":"string"},"actionsOn":{"items":{"properties":{"metapropertyId":{"format":"uuid","type":"string"},"optionIds":{"items":{"format":"uuid","type":"string"},"type":"array"},"value":{"type":"string"}},"type":"object"},"type":"array"},"conditionType":{"enum":["ALL","ANY","ANY_OPTION"],"type":"string"},"triggerType":{"enum":["SELECTED"],"type":"string"},"triggersOn":{"items":{"properties":{"metapropertyId":{"format":"uuid","type":"string"},"optionIds":{"items":{"format":"uuid","type":"string"},"type":"array"},"value":{"type":"string"}},"type":"object"},"type":"array"}},"required":["actionType","conditionType","actionsOn","triggersOn"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"AutomationCreatedOutput":{"summary":"Response when automation was successfully created","value":{"automationId":"00000000-0000-0000-0000-000000000000","message":"The automation has been created"}}},"schema":{"properties":{"automationId":{"format":"uuid","type":"string"},"message":{"type":"string"}},"required":["automationId","message"],"type":"object"}}},"description":""},"400":{"content":{"application/json":{"examples":{"ConflictingAllConditionOutput":{"description":"This occurs when an existing automation with an \"any\" condition overlaps with the new automation's triggers.","summary":"Response when there will be a conflict if creating an automation with an \"all\" condition","value":{"errorCode":"condition-all-conflict","message":"Creating an automation with condition \"all\" will create a conflict"}},"ConflictingAnyConditionOutput":{"description":"This occurs when an existing automation with an \"all\" condition overlaps with the new automation's triggers.","summary":"Response when there will be a conflict if creating an automation with an \"any\" condition","value":{"errorCode":"condition-any-conflict","message":"Creating an automation with condition \"any\" will create a conflict"}},"DuplicateAutomationOutput":{"summary":"Response when the automation already exists","value":{"errorCode":"duplicate","message":"The automation already exists"}},"InvalidAutomationOutput":{"summary":"Response when the input automation is invalid","value":{"errorCode":"validation-failure","errors":[],"message":"The input is invalid"}},"TaxonomyErrorOutput":{"summary":"Response when an error occurred while checking the taxonomy","value":{"errorCode":"taxonomy-error","errors":[],"message":"Errors occurred while checking the taxonomy"}}},"schema":{"properties":{"errorCode":{"type":"string"},"errors":{"items":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":""},"401":{"content":{"application/json":{"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Create automation","tags":["Automations - New taxonomy API"]}},"/api/1/automation/automations/{automationId}":{"delete":{"description":"Delete an automation by id.","operationId":"deleteApi1AutomationAutomationsAutomationid","parameters":[{"in":"header","name":"x-api-correlation-id","required":false,"schema":{"type":"string"}},{"in":"path","name":"automationId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"202":{"content":{"application/json":{"examples":{"AutomationDeletedOutput":{"summary":"Response when automation was successfully deleted","value":{"message":"The automation has been deleted"}}},"schema":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"}}},"description":""},"401":{"content":{"application/json":{"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"}}},"description":""},"404":{"content":{"application/json":{"examples":{"AutomationNotFoundOutput":{"summary":"Response when automation was not found","value":{"errorCode":"automation-not-found","message":"The automation was not found"}}},"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Delete automation","tags":["Automations - New taxonomy API"]},"get":{"description":"Retrieve a single automation by its unique id.","operationId":"getApi1AutomationAutomationsAutomationid","parameters":[{"in":"header","name":"x-api-correlation-id","required":false,"schema":{"type":"string"}},{"in":"path","name":"automationId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"AutomationExample":{"description":"This automation describes the following: If the 'Image' option from 'Asset' metaproperty is selected, then show the 'Marketing' option from 'Asset Sub-Type' metaproperty.","summary":"An example of an automation response","value":{"actionType":"SHOW_OPTION","actionsOn":[{"metapropertyId":"7bed26c4-e39d-4051-8197-69bed161bda8","metapropertyName":"Asset Sub-Type","metapropertyType":"single-select","options":[{"optionId":"183e852d-a1b0-4f62-bfbd-2a093df03a6a","optionName":"Marketing"}],"value":""}],"automationId":"00000000-0000-0000-0000-000000000000","conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"ccea2875-868c-4a75-9354-53150d2db055","metapropertyName":"Asset","metapropertyType":"single-select","options":[{"optionId":"677c5b4d-1eb2-4e87-9bd8-5f2825522b3a","optionName":"Image"}],"value":""}]}}},"schema":{"properties":{"actionType":{"enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"],"type":"string"},"actionsOn":{"items":{"properties":{"metapropertyId":{"type":"string"},"metapropertyName":{"type":"string"},"metapropertyType":{"type":"string"},"options":{"items":{"properties":{"optionId":{"type":"string"},"optionName":{"type":"string"}},"required":["optionId","optionName"],"type":"object"},"type":"array"},"value":{"type":"string"}},"type":"object"},"type":"array"},"automationId":{"type":"string"},"conditionType":{"enum":["ALL","ANY","ANY_OPTION"],"type":"string"},"triggerType":{"enum":["SELECTED"],"type":"string"},"triggersOn":{"items":{"properties":{"metapropertyId":{"type":"string"},"metapropertyName":{"type":"string"},"metapropertyType":{"type":"string"},"options":{"items":{"properties":{"optionId":{"type":"string"},"optionName":{"type":"string"}},"required":["optionId","optionName"],"type":"object"},"type":"array"},"value":{"type":"string"}},"type":"object"},"type":"array"}},"required":["automationId","actionType","conditionType","triggerType"],"type":"object"}}},"description":""},"401":{"content":{"application/json":{"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"}}},"description":""},"404":{"content":{"application/json":{"examples":{"AutomationNotFoundOutput":{"summary":"Response when automation was not found","value":{"errorCode":"automation-not-found","message":"The automation was not found"}}},"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Retrieve automation by id","tags":["Automations - New taxonomy API"]},"put":{"description":"Modify an automation. Make sure to use one of the supported bodies listed in the cURL request examples. E.g. ShowOptionAll, DenyDownloads, etc.","operationId":"putApi1AutomationAutomationsAutomationid","parameters":[{"in":"header","name":"x-api-correlation-id","required":false,"schema":{"type":"string"}},{"in":"path","name":"automationId","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"ApplyWatermark":{"description":"Automatically apply watermark to assets when specific metaproperty options are selected.","summary":"Apply watermark automation","value":{"actionType":"SELECT","actionsOn":[{"value":"watermark"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ArchiveAssets":{"description":"Automatically archive assets when specific metaproperty options are selected.","summary":"Archive assets automation","value":{"actionType":"SELECT","actionsOn":[{"value":"archive"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"DenyDownloads":{"description":"Automatically deny downloading of assets when specific metaproperty options are selected.","summary":"Deny asset downloads automation","value":{"actionType":"DESELECT","actionsOn":[{"value":"watermark"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"EmptyMetaproperty":{"description":"Automatically clears the value of a text or date metaproperty when specific conditions are met. This type of automation can only be used with Text and Date metaproperties.","summary":"Empty metaproperty automation","value":{"actionType":"EMPTY","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"MarkAsLimitedUsage":{"description":"Automatically mark assets as limited usage when specific metaproperty options are selected.","summary":"Mark assets as limited usage automation","value":{"actionType":"SELECT","actionsOn":[{"value":"limited"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"PrefillMetaproperty":{"description":"Automatically fills a text or date metaproperty with a predefined value when specific options are selected. This type of automation can only be used with Text and Date metaproperties. Furthermore, the value must be in the correct format - free text for Text metaproperties and DD/MM/YYYY for Date metaproperties.","summary":"Prefill text metaproperty automation","value":{"actionType":"PREFILL","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","value":"text_that_should_be_prefilled"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ShowMetapropertyAnyOption":{"description":"Show metaproperty based on any option selection. Triggers when any option from the specified trigger metaproperty is selected.","summary":"Show metaproperty based on any trigger options","value":{"actionType":"SHOW_METAPROPERTY","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}],"conditionType":"ANY_OPTION","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}]}},"ShowMetapropertySpecificOptions":{"description":"Show metaproperty based on specific option selection. Triggers when any of the specified options from the trigger metaproperty are selected.","summary":"Show metaproperty based on specific trigger options","value":{"actionType":"SHOW_METAPROPERTY","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ShowOptionAll":{"description":"Show specific options based on multiple trigger option selection. Automation will apply if all the triggering options are selected.","summary":"Show options with ALL condition","value":{"actionType":"SHOW_OPTION","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}],"conditionType":"ALL","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000001","optionIds":["00000000-0000-0000-0000-000000000001"]},{"metapropertyId":"00000000-0000-0000-0000-000000000002","optionIds":["00000000-0000-0000-0000-000000000002"]}]}},"ShowOptionAny":{"description":"Show specific options based on trigger option selection. Automation will apply if any of the triggering options is selected.","summary":"Show options with any specific options","value":{"actionType":"SHOW_OPTION","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}}},"schema":{"properties":{"actionType":{"enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"],"type":"string"},"actionsOn":{"items":{"properties":{"metapropertyId":{"format":"uuid","type":"string"},"optionIds":{"items":{"format":"uuid","type":"string"},"type":"array"},"value":{"type":"string"}},"type":"object"},"type":"array"},"conditionType":{"enum":["ALL","ANY","ANY_OPTION"],"type":"string"},"triggerType":{"enum":["SELECTED"],"type":"string"},"triggersOn":{"items":{"properties":{"metapropertyId":{"format":"uuid","type":"string"},"optionIds":{"items":{"format":"uuid","type":"string"},"type":"array"},"value":{"type":"string"}},"type":"object"},"type":"array"}},"required":["actionType","conditionType","triggerType"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"AutomationUpdatedOutput":{"summary":"Response when automation was successfully updated","value":{"message":"The automation has been updated"}}},"schema":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"}}},"description":""},"400":{"content":{"application/json":{"examples":{"ConflictingAllConditionOutput":{"description":"This occurs when an existing automation with an \"any\" condition overlaps with the new automation's triggers.","summary":"Response when there will be a conflict if creating an automation with an \"all\" condition","value":{"errorCode":"condition-all-conflict","message":"Creating an automation with condition \"all\" will create a conflict"}},"ConflictingAnyConditionOutput":{"description":"This occurs when an existing automation with an \"all\" condition overlaps with the new automation's triggers.","summary":"Response when there will be a conflict if creating an automation with an \"any\" condition","value":{"errorCode":"condition-any-conflict","message":"Creating an automation with condition \"any\" will create a conflict"}},"DuplicateAutomationOutput":{"summary":"Response when the automation already exists","value":{"errorCode":"duplicate","message":"The automation already exists"}},"InvalidAutomationOutput":{"summary":"Response when the input automation is invalid","value":{"errorCode":"validation-failure","errors":[],"message":"The input is invalid"}},"TaxonomyErrorOutput":{"summary":"Response when an error occurred while checking the taxonomy","value":{"errorCode":"taxonomy-error","errors":[],"message":"Errors occurred while checking the taxonomy"}}},"schema":{"properties":{"errorCode":{"type":"string"},"errors":{"items":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":""},"401":{"content":{"application/json":{"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"}}},"description":""},"404":{"content":{"application/json":{"examples":{"AutomationNotFoundOutput":{"summary":"Response when automation was not found","value":{"errorCode":"automation-not-found","message":"The automation was not found"}}},"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"type":"object"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Modify automation","tags":["Automations - New taxonomy API"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}]}
```