# Update a client

`PATCH https://rebaar.in/api/v1/clients/{id}`

Changes name, contact, GSTIN or location. A new `pincode` decides its own state and district. The email is the client's portal login: changing it signs the old address out and tells it, and changes are capped per day (429 `email_change_limit`); taking it off is always allowed.

## Headers

| Header | Value |
|---|---|
| `Authorization` | `Bearer <your API key>` |
| `Content-Type` | `application/json` |

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `id` | path | string | yes | The client id, as returned by the list endpoint. |

## Request body

Any subset of fields; pass null to clear an optional field.

| Field | Type | Required | Description |
|---|---|---|---|
| `name` | string | no | at most 200 characters |
| `contactPerson` | string or null | no | at most 200 characters |
| `email` | string (email) or null | no |  |
| `phone` | string or null | no | at most 20 characters |
| `city` | string or null | no |  |
| `pincode` | string | no | 6-digit PIN code. The server fills stateCode and district from it when they are not sent.. pattern ^[1-9][0-9]{5}$ |
| `district` | string | no | at most 80 characters |
| `stateCode` | string | no | 2-digit GST state code, e.g. "29" (Karnataka). 400 with field "pincode" when the PIN is not in that state.. pattern ^[0-9]{2}$ |
| `gstin` | string or null | no | pattern ^[0-9A-Z]{15}$ |

## Example

```bash
curl -X PATCH 'https://rebaar.in/api/v1/clients/7d3f1c2a-5b8e-4f0a-9c61-2e4b7a9d0c13' \
  -H 'Authorization: Bearer ck_live_xxxxxxxx_…' \
  -H 'Content-Type: application/json' \
  -d '{
  "contactPerson": "Rahul Menon",
  "pincode": "560034"
}'
```

## Responses

### 200

Updated. The body is `{ "ok": true }` — GET the record for its new state.

```json
{
  "ok": true
}
```

### 400

Validation failed. `error` is the first problem found; `field` names it when it is a location, GSTIN, email or delivery-address field.

```json
{
  "error": "no fields to update"
}
```

### 401

No `Authorization: Bearer …` header was sent. Or: The key is unknown, revoked or expired — or the company cannot use it.

`unauthenticated` — No `Authorization: Bearer …` header was sent.

```json
{
  "error": "unauthenticated",
  "message": "Authorization: Bearer <api_key> required"
}
```

`invalid_token` — The key is unknown, revoked or expired — or the company cannot use it.

```json
{
  "error": "invalid_token",
  "message": "API key not recognised, revoked, or expired"
}
```

### 402

The company is not on the Scale plan, which includes the API. Or: The subscription is not active (trial over, payment failed, cancelled, paused, locked or closing). `reason` says which.

`plan_required` — The company is not on the Scale plan, which includes the API.

```json
{
  "error": "plan_required",
  "message": "API access requires the Scale plan. This workspace is on Growth.",
  "currentPlan": "growth",
  "requiredPlan": "scale"
}
```

`access_expired` — The subscription is not active (trial over, payment failed, cancelled, paused, locked or closing). `reason` says which.

```json
{
  "error": "access_expired",
  "reason": "payment_failed",
  "message": "Workspace does not currently have an active Scale subscription."
}
```

### 403

The request came from an IP address that is not on the key's allowlist. Or: The key does not carry the scope this method needs: `read` for GET, `write` for POST, PATCH and DELETE.

`ip_not_allowed` — The request came from an IP address that is not on the key's allowlist.

```json
{
  "error": "ip_not_allowed",
  "message": "Source IP 203.0.113.7 is not on the key's allowlist."
}
```

`insufficient_scope` — The key does not carry the scope this method needs: `read` for GET, `write` for POST, PATCH and DELETE.

```json
{
  "error": "insufficient_scope",
  "message": "This API key does not have the 'write' scope.",
  "required": "write",
  "granted": [
    "read"
  ]
}
```

### 404

No such client in this workspace.

```json
{
  "error": "not_found"
}
```

### 409

The email changed while this request was being handled — read the client again and retry.

```json
{
  "error": "email_changed_meanwhile",
  "message": "This client's email was changed while you were editing — reload and try again.",
  "field": "email"
}
```

### 429

Too many requests, or too many email changes for this client today.

`rate_limited`

```json
{
  "error": "Too many requests. Please try again later."
}
```

`email_change_limit`

```json
{
  "error": "email_change_limit",
  "message": "This client's email has been changed 3 times in the last 24 hours — try again tomorrow.",
  "field": "email"
}
```

### 500

Something failed on our side.

`internal` — Something failed on our side.

```json
{
  "error": "internal"
}
```

## Errors every call can return

| Status | Code | Meaning | What to do |
|---|---|---|---|
| 401 | `unauthenticated` | No `Authorization: Bearer …` header was sent. | Send your API key as `Authorization: Bearer ck_live_…` on every request. |
| 401 | `invalid_token` | The key is unknown, revoked or expired — or the company cannot use it. | Check you copied the whole key. Make a new one in Settings → API keys if it was revoked or has expired. |
| 403 | `ip_not_allowed` | The request came from an IP address that is not on the key's allowlist. | Call from an allowed address, or change the key's IP allowlist in Settings → API keys. |
| 402 | `plan_required` | The company is not on the Scale plan, which includes the API. | The Owner moves the company to Scale in Settings → Billing. |
| 402 | `access_expired` | The subscription is not active (trial over, payment failed, cancelled, paused, locked or closing). `reason` says which. | The Owner pays or renews in Settings → Billing; calls work again at once. |
| 429 | — | More than 120 requests in a minute with this key (30 with a sandbox key). | Wait the number of seconds in the `Retry-After` header. Every reply carries `RateLimit-Remaining`, so you can slow down before this happens. |
| 403 | `insufficient_scope` | The key does not carry the scope this method needs: `read` for GET, `write` for POST, PATCH and DELETE. | Make a key with the scope you need in Settings → API keys. |
| 500 | `internal` | Something failed on our side. | Retry with exponential backoff. If it keeps happening, email support@rebaar.in with the time of the call. |