# Update Automation

[View original](https://ittybit.com/api/automations/update)


`PATCH /automations/{id}`

Updates an automation's `name`, `description`, `trigger`, `workflow`, or `status`. Only the specified fields will be updated.

### Parameters

```json
[
  {
    "in": "path",
    "name": "id",
    "required": true,
    "schema": {
      "type": "string",
      "example": "auto_abcdefgh1234"
    }
  }
]
```

### Request Body

The request body should contain a properly formatted JSON object. See [Automation Objects](/docs/automations) and [Tasks](/docs/tasks) for all the optional props.

**Schema:**

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "trigger": {
      "type": "object",
      "required": [
        "kind",
        "event"
      ],
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "event"
          ]
        },
        "event": {
          "type": "string",
          "enum": [
            "media.created"
          ]
        }
      }
    },
    "workflow": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WorkflowTaskStep"
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "paused"
      ]
    }
  }
}
```

**Example:**

```json
{
  "name": "My Updated Automation",
  "workflow": [
    {
      "kind": "nsfw"
    },
    {
      "kind": "description"
    },
    {
      "kind": "image",
      "width": 480,
      "format": "png",
      "ref": "big_thumbnail"
    },
    {
      "kind": "conditions",
      "conditions": [
        {
          "prop": "media.kind",
          "value": "video"
        }
      ],
      "next": [
        {
          "kind": "subtitle",
          "ref": "subtitle"
        }
      ]
    }
  ],
  "status": "active"
}
```

### Responses

#### 200 - Success

**Example:**

```json
{
  "meta": {
    "request_id": "req_abcdefghij1234567890",
    "org_id": "org_abcdefgh1234",
    "project_id": "prj_abcdefgh1234",
    "version": "2025-01-01",
    "type": "object"
  },
  "data": {
    "id": "auto_abcdefgh1234",
    "object": "automation",
    "name": "My Updated Automation",
    "description": "This workflow will run whenever new media is created.",
    "trigger": {
      "kind": "event",
      "event": "media.created"
    },
    "workflow": [
      {
        "kind": "nsfw"
      },
      {
        "kind": "description"
      },
      {
        "kind": "image",
        "width": 480,
        "format": "png",
        "ref": "big_thumbnail"
      },
      {
        "kind": "conditions",
        "conditions": [
          {
            "prop": "kind",
            "value": "video"
          }
        ],
        "next": [
          {
            "kind": "subtitle",
            "ref": "subtitle"
          }
        ]
      }
    ],
    "created": "2025-01-01T01:23:45Z",
    "updated": "2025-01-02T01:23:45Z",
    "status": "active"
  },
  "error": null,
  "links": {
    "self": "https://api.ittybit.com/automations/auto_abcdefgh1234",
    "parent": "https://api.ittybit.com/automations"
  }
}
```