# Edit an automation

Source: https://jointextkit.com/docs/api/automations/update
Index: https://jointextkit.com/llms.txt

`PATCH /v1/automations/{id}`

Editing an active automation publishes a new version at once and must leave it valid; runs in progress finish on the version they started with. Pause first to save work in progress.

Send your API key as a bearer token: `Authorization: Bearer ssms_sk_...`. Test keys run this endpoint against the [sandbox](/docs/sandbox); see [Authentication](/docs/authentication) for key modes and scopes.

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes |  |

## Request body

JSON (`Content-Type: application/json`).

A `AutomationInput` object.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No | At most 80 characters. |
| `from` | string | No | One of your numbers. A sandbox number makes it a sandbox flow. Nullable. |
| `topic_id` | string | No | Skip recipients unsubscribed from this topic. Nullable. |
| `trigger` | object | No |  |
| `trigger.event` | string | No | Example: `trial_started`. |
| `trigger.filters` | array of object | No | At most 5 items. |
| `trigger.filters[].property` | string | No |  |
| `trigger.filters[].op` | string | No |  |
| `trigger.filters[].value` | any | No |  |
| `steps` | array of AutomationStep | No | At most 20 items. |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | Updated automation | `Automation` |
| 401 | Missing, malformed, or revoked API key | `Error` |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | `Error` |
| 429 | Rate limit or quota exceeded | `Error` |

### 200: `Automation` fields

| Field | Type | Description |
| --- | --- | --- |
| `id` | string | Example: `auto_a1B2c3D4e5F6`. |
| `object` | `automation` |  |
| `name` | string |  |
| `status` | `draft`, `active`, `paused` |  |
| `trigger` | object |  |
| `steps` | array of AutomationStep |  |
| `from` | string | Nullable. |
| `topic_id` | string | Nullable. |
| `test` | boolean | Sandbox or live, decided by the sender number. Nullable. |
| `version` | integer | Published version; runs are pinned to the one they started on. |
| `unpublished_changes` | boolean |  |
| `stats` | object |  |
| `stats.runs_started` | integer |  |
| `stats.runs_active` | integer |  |
| `stats.runs_completed` | integer |  |
| `stats.runs_failed` | integer |  |
| `stats.runs_opted_out` | integer |  |
| `stats.triggers_skipped` | integer | Triggers ignored because that person already had a run in progress. |
| `stats.messages_sent` | integer |  |
| `stats.last_triggered_at` | string (date-time) | Nullable. |
| `issues` | array of object | What stops this flow from running. Empty when it can be activated. |
| `issues[].where` | string | A step id, "trigger" or "flow". |
| `issues[].field` | string |  |
| `issues[].message` | string |  |
| `created_at` | string (date-time) |  |
| `updated_at` | string (date-time) |  |

## Errors

| Status | When |
| --- | --- |
| 401 | Missing, malformed, or revoked API key |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged |
| 429 | Rate limit or quota exceeded |

Every error has the same JSON shape, and `request_id` matches the `X-Request-Id` response header. [Errors](/docs/errors) lists every code and what to do about it.

```json
{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}
```

## Examples

### Node.js

The Node.js SDK does not wrap this endpoint yet; call it over HTTP.

```javascript
const res = await fetch('https://api.jointextkit.com/v1/automations/auto_a1B2c3D4e5F6', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();
```

### PHP

```php
<?php

$ch = curl_init('https://api.jointextkit.com/v1/automations/auto_a1B2c3D4e5F6');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('TEXTKIT_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode((object) []),
]);

$data = json_decode(curl_exec($ch), true);
```

### Python

The Python SDK does not wrap this endpoint yet; call it over HTTP.

```python
import json, os, urllib.request

req = urllib.request.Request(
    "https://api.jointextkit.com/v1/automations/auto_a1B2c3D4e5F6",
    method="PATCH",
    headers={
        "Authorization": f"Bearer {os.environ['TEXTKIT_API_KEY']}",
        "Content-Type": "application/json",
    },
    data=json.dumps({}).encode(),
)
with urllib.request.urlopen(req) as res:
    data = json.load(res)
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://api.jointextkit.com/v1/automations/auto_a1B2c3D4e5F6")
req = Net::HTTP::Patch.new(uri)
req["Authorization"] = "Bearer #{ENV["TEXTKIT_API_KEY"]}"
req["Content-Type"] = "application/json"
req.body = {}.to_json

res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### Go

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{}`)
	req, _ := http.NewRequest("PATCH", "https://api.jointextkit.com/v1/automations/auto_a1B2c3D4e5F6", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("TEXTKIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(data))
}
```

### Rust

```rust
// cargo add reqwest --features blocking,json
// cargo add serde_json
use serde_json::json;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let key = std::env::var("TEXTKIT_API_KEY")?;
    let res = reqwest::blocking::Client::new()
        .patch("https://api.jointextkit.com/v1/automations/auto_a1B2c3D4e5F6")
        .bearer_auth(key)
        .json(&json!({}))
        .send()?
        .error_for_status()?;
    let data: serde_json::Value = res.json()?;
    println!("{data}");
    Ok(())
}
```

### Java

```java
import java.net.URI;
import java.net.http.*;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder(URI.create("https://api.jointextkit.com/v1/automations/auto_a1B2c3D4e5F6"))
            .header("Authorization", "Bearer " + System.getenv("TEXTKIT_API_KEY"))
            .header("Content-Type", "application/json")
            .method("PATCH", HttpRequest.BodyPublishers.ofString("""
                {}
                """))
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
```

### .NET

```csharp
using System.Net.Http.Headers;
using System.Text;

var http = new HttpClient();
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(
    "Bearer", Environment.GetEnvironmentVariable("TEXTKIT_API_KEY"));

var body = new StringContent("""
    {}
    """, Encoding.UTF8, "application/json");
var res = await http.PatchAsync("https://api.jointextkit.com/v1/automations/auto_a1B2c3D4e5F6", body);
res.EnsureSuccessStatusCode();

var data = await res.Content.ReadAsStringAsync();
```

### cURL

```bash
curl -X PATCH "https://api.jointextkit.com/v1/automations/auto_a1B2c3D4e5F6" \
  -H "Authorization: Bearer $TEXTKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

## Related

- Guide: [Automations](/docs/automations)
- [All automations endpoints](/docs/api#automations)
- [API reference](/docs/api)