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

> Full API specification: https://earlyaccess.developers.bynder.com/apis/automations-api-1/versions/c7c13882-9e51-4554-bcb8-9517eda44741.md

# Modify automation

`PUT` `/api/1/automation/automations/{automationId}`

Operation ID: `putApi1AutomationAutomationsAutomationid`

Modify an automation. Make sure to use one of the supported bodies listed in the cURL request examples. E.g. ShowOptionAll, DenyDownloads, etc.

## Path parameters

- `automationId` (string, uuid, required)

## Header parameters

- `x-api-correlation-id` (string, optional)

## Request body (required)

Content types: `application/json`

## Responses

- `202`
- `400`
- `401`
- `404`

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Automations API
  version: "1.0"
servers:
  - url: https://{your-bynder-domain}/
paths:
  /api/1/automation/automations/{automationId}:
    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
security:
  - httpAuth: []
components:
  securitySchemes:
    httpAuth:
      scheme: bearer
      type: http
```
