# Retry failed recipients

Source: https://jointextkit.com/docs/api/batches/retry-batch
Index: https://jointextkit.com/llms.txt

`POST /v1/batches/{id}/retry`

Re-queues failures that can succeed on a retry (rate limits, quota, carrier errors), up to 3 attempts per recipient. Opt-outs, invalid numbers and recipients this batch already messaged are never retried. Only for complete batches.

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 |  |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | The updated batch, plus affected and sweep_complete | `Batch` |
| 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` |
| 404 | Not found | `Error` |
| 409 | Not allowed in the batch’s current status (or a retry is already running) | `Error` |
| 429 | Rate limit or quota exceeded | `Error` |

### 200: `Batch` fields

| Field | Type | Description |
| --- | --- | --- |
| `id` | string | Example: `bc_a1B2c3D4e5F6`. |
| `object` | `batch` |  |
| `name` | string |  |
| `status` | `scheduled`, `sending`, `paused`, `complete`, `canceled` |  |
| `from` | string |  |
| `body` | string |  |
| `source` | `api`, `csv`, `contacts` |  |
| `test` | boolean |  |
| `scheduled_at` | string (date-time) | Nullable. |
| `created_at` | string (date-time) |  |
| `completed_at` | string (date-time) | Nullable. |
| `counts` | object | total = queued + sent + failed + opted_out + canceled, always. "sent" = accepted by the carrier; what happened next (delivered, failed, replies) is GET /v1/batches/{id}/results. "opted_out" also counts recipients unsubscribed from the batch topic. |
| `counts.total` | integer |  |
| `counts.queued` | integer |  |
| `counts.sent` | integer |  |
| `counts.failed` | integer |  |
| `counts.opted_out` | integer |  |
| `counts.canceled` | integer |  |
| `rejected` | object | Rows dropped at validation (not part of total), by reason. Nullable. |
| `variables` | array of string |  |
| `retries` | integer |  |

## 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 |
| 404 | Not found |
| 409 | Not allowed in the batch’s current status (or a retry is already running) |
| 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/batches/bc_a1B2c3D4e5F6/retry', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`,
  },
});

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/batches/bc_a1B2c3D4e5F6/retry');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('TEXTKIT_API_KEY'),
    ],
]);

$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/batches/bc_a1B2c3D4e5F6/retry",
    method="POST",
    headers={
        "Authorization": f"Bearer {os.environ['TEXTKIT_API_KEY']}",
    },
)
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/batches/bc_a1B2c3D4e5F6/retry")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV["TEXTKIT_API_KEY"]}"

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"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.jointextkit.com/v1/batches/bc_a1B2c3D4e5F6/retry", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("TEXTKIT_API_KEY"))

	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

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let key = std::env::var("TEXTKIT_API_KEY")?;
    let res = reqwest::blocking::Client::new()
        .post("https://api.jointextkit.com/v1/batches/bc_a1B2c3D4e5F6/retry")
        .bearer_auth(key)
        .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/batches/bc_a1B2c3D4e5F6/retry"))
            .header("Authorization", "Bearer " + System.getenv("TEXTKIT_API_KEY"))
            .method("POST", HttpRequest.BodyPublishers.noBody())
            .build();

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

### .NET

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

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

var res = await http.SendAsync(new HttpRequestMessage(new HttpMethod("POST"), "https://api.jointextkit.com/v1/batches/bc_a1B2c3D4e5F6/retry"));
res.EnsureSuccessStatusCode();

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

### cURL

```bash
curl -X POST "https://api.jointextkit.com/v1/batches/bc_a1B2c3D4e5F6/retry" \
  -H "Authorization: Bearer $TEXTKIT_API_KEY"
```

## Related

- Guide: [Batches & broadcasts](/docs/broadcasts)
- [All batches endpoints](/docs/api#batches)
- [API reference](/docs/api)