Summary
          Updates an automation's attributes.
          Description
          Updates an automation's attributes (including scheduling data).
          Route
          PUT /automation_catalog/automations/:id
          Roles
          
            admin
other
apiread
          
          Parameters
          
            DetailsExampleSchema
          
          
            
              
                | Name | Type | Required | Description | 
            
            
              
    | id | string | yes | Unique id of the automation | 
    | options | object | yes | Object containing the fields to be updated | 
            
          
          
            Copied to Clipboard
            
            {
  "options": {
    "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
    "formId": "1f46853a2c620207ae6c7e29",
    "gbac": {
      "write": [
        "6fb8477a846c45b1062c8a25"
      ],
      "read": [
        "d2b281a98f49bdc0f295e03b",
        "51ce4319aaba42c8c9b871e2",
        "f521c0530febc2000153f3c8"
      ]
    },
    "nextRunAt": null,
    "repeatInterval": "3 weeks"
  }
}
           
          
            Copied to Clipboard
            
            {
  "type": "object",
  "properties": {
    "options": {
      "title": "options",
      "type": "object",
      "description": "Custom data stored with an automation.",
      "properties": {
        "formData": {
          "type": "object",
          "properties": {},
          "description": "An object containing a list of properties from the associated json-form, saved formData is only used when scheduling."
        },
        "workflowId": {
          "type": "string",
          "examples": [
            "8e3695fe-c5bf-4286-ae83-186b3fea1c1a"
          ],
          "format": "uuid"
        },
        "formId": {
          "$ref": "automationDocument#/definitions/ObjectId"
        },
        "gbac": {
          "type": "object",
          "description": "Sets of group Ids that are allowed to access this automation.",
          "properties": {
            "write": {
              "type": "array",
              "description": "Group ids that have write access to the automation document.",
              "items": {
                "$ref": "automationDocument#/definitions/ObjectId"
              }
            },
            "read": {
              "type": "array",
              "description": "Group ids that have read access to the automation document.",
              "items": {
                "$ref": "automationDocument#/definitions/ObjectId"
              }
            }
          },
          "required": [
            "write",
            "read"
          ]
        },
        "nextRunAt": {
          "oneOf": [
            {
              "type": "string",
              "examples": [
                "2019-11-25T22:51:39.201Z"
              ],
              "format": "date-time",
              "description": "Agenda property defining when the next run will process, stored in UTC."
            },
            {
              "type": "null"
            }
          ]
        },
        "repeatInterval": {
          "oneOf": [
            {
              "type": "string",
              "minLength": 1,
              "description": "Agenda property defining how often an automation will repeat. Stored in human interval time format (https://github.com/agenda/human-interval).",
              "examples": [
                "1 hour",
                "1 day",
                "3 weeks",
                "2 months"
              ]
            },
            {
              "type": "null"
            }
          ]
        }
      }
    }
  },
  "required": [
    "options"
  ],
  "additionalProperties": false
}
           
          Return
          
            DetailsExampleSchema
          
          
            
              
                | Name | Type | Description | 
            
            
              
                | document | object | Updated document of requested automation | 
            
          
          
            Copied to Clipboard
            
            {
  "_id": "f08eea028c972015002d22a0",
  "name": "test",
  "data": {
    "gbac": {
      "write": [
        "d31a21a2181fdf4fd77ff5ad"
      ],
      "read": [
        "dfa2750d33d2937708f4a0ce",
        "a977d0b3186558f7df54402a"
      ]
    },
    "lastUpdated": "2019-11-25T22:51:39.201Z",
    "description": "est",
    "workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
    "formId": "8423c07825d4c4df1c4ed2ad"
  },
  "lastModifiedBy": "consequat enim magna ad",
  "lastRunAt": "2019-11-25T22:51:39.201Z",
  "nextRunAt": "2019-11-25T22:51:39.201Z",
  "repeatInterval": "1 hour"
}