# Rename a relationship category

`PUT /api/v1/relationship-categories/{relationshipCategory}`

Change what one of your own categories is called.

A category the product supplied cannot be renamed, and answers 422. Its wording belongs to the product and reads in the language of whoever is looking, which is what would be lost. Move it, retire it, or file your types under a category of your own instead.

The types under the category are untouched by a rename, and so is where the category sits.

## Parameters

- `relationshipCategory` (uuid, required): The id of the category. A path that is not a uuid answers 404 without a query being run.
- `name` (string, optional): What the category is called. Up to 255 characters. It cannot be null.

## Returns

The relationship category object as it now reads. A supplied category answers 422.

- `data` (object): The category.
- `data.type` (string): Always relationship_category. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.
- `data.id` (string): The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.
- `data.attributes` (object): Everything the record holds.
- `data.attributes.name` (string): What the category is called. A category the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here.
- `data.attributes.position` (integer): Where the category sits in the settings and in the picker, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had.
- `data.attributes.is_system` (boolean): Whether the product supplied the category with the account. A supplied category may be moved and retired, never renamed and never deleted, because the wording it falls back to belongs to the product.
- `data.attributes.is_active` (boolean): Whether the category and the types under it are offered when a new relationship is written. False removes the whole category from that choice and touches nothing already written: every relationship stays readable.
- `data.attributes.type_count` (integer): How many relationship types sit under the category, retired ones counted. It is what decides whether the category may be deleted, since one still holding a type cannot go.
- `data.attributes.created_at` (timestamp): When the category was added, as a count of seconds since 1970 rather than a written date.
- `data.attributes.updated_at` (timestamp): When it last changed, as a count of seconds. Equal to created_at until it first changes.
- `data.links` (object): Where to find this record.
- `data.links.self` (string): The absolute address this record is read from.

## Rate limit

Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in `X-RateLimit-Remaining`.

## Request

```sh
curl https://my.monicahq.com/api/v1/relationship-categories/b42e9c07-5a18-4d73-8e60-1c9f2b7a4d35 \
  -X PUT \
  -H "Authorization: Bearer $MONICA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "name": "Neighbourhood"
  }'
```

```javascript
const response = await fetch('https://my.monicahq.com/api/v1/relationship-categories/b42e9c07-5a18-4d73-8e60-1c9f2b7a4d35', {
  method: 'PUT',
  headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    name: 'Neighbourhood',
  }),
})
const data = await response.json()
```

```php
$response = Http::withToken($token)->put('https://my.monicahq.com/api/v1/relationship-categories/b42e9c07-5a18-4d73-8e60-1c9f2b7a4d35', [
    'name' => 'Neighbourhood',
]);
```

## Response

`200`

```json
{
    "data": {
        "type": "relationship_category",
        "id": "b42e9c07-5a18-4d73-8e60-1c9f2b7a4d35",
        "attributes": {
            "name": "Neighbourhood",
            "position": 6,
            "is_system": false,
            "is_active": true,
            "type_count": 0,
            "created_at": 1756339200,
            "updated_at": 1756425600
        },
        "links": {
            "self": "https://my.monicahq.com/api/v1/relationship-categories/b42e9c07-5a18-4d73-8e60-1c9f2b7a4d35"
        }
    }
}
```
