> For a complete page index, fetch https://developer.close.com/llms.txt

# Rename a standard object label

PUT https://api.close.com/api/v1/standard_object_label/{label_type}/
Content-Type: application/json

Both `singular` and `plural` are required; the pair replaces the current label.
Names are compared case-insensitively and may not collide with a custom object
or with another standard object label. Submitting the built-in default names
resets the label, exactly as a `DELETE` would.

Reference: https://developer.close.com/api/resources/standard-object-labels/update

## Authentication

- `Authorization` header (basic auth, required) — Use your API key as the username and leave the password empty.
- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `label_type` (string, required)

### Body (application/json)

This endpoint expects an UpdateStandardObjectLabel.

- `plural` (string, required) — Name used when referring to multiple objects.
- `singular` (string, required) — Name used when referring to a single object.

## Response

### 200

Successful response

- `is_customized` (boolean, required)
- `label_type` (enum, required)
  - Allowed values: `lead`, `lead_status`, `contact`, `opportunity`, `opportunity_status`
- `organization_id` (string, required)
- `plural` (string, required)
- `singular` (string, required)

## Errors

### 400 Bad Request Error

Bad request, such as a validation error.

- `Standard_object_labels_updateRequestBadRequestError`
  - ErrorMessage: ErrorMessage
  - ValidationErrors: ValidationErrors
  - NestedValidationErrors: NestedValidationErrors

### 401 Unauthorized Error

Authentication is missing or invalid.

- `error` (string, required) — Error message.

### 403 Forbidden Error

The requestor lacks the Manage Customizations permission, or renaming standard object labels is not enabled for the organization.

- `Standard_object_labels_updateRequestForbiddenError`
  - ErrorMessage: ErrorMessage
  - ApiKeyError: ApiKeyError

### 404 Not Found Error

Not found.

- `error` (string, required) — Error message.

### 429 Too Many Requests Error

Too many requests. The global API rate limiter returns an empty body. Other rate and operation limits return a `RateLimitError` body. Wait for the number of seconds in the `retry-after` header before retrying.

- `error` (RateLimitErrorError, required)

## Types

### ErrorMessage

Error with a message.

- `error` (string, required) — Error message.

### ValidationErrors

Validation errors with the path of each invalid field.

- `errors` (list of ValidationErrorsErrorsItems, required)

### NestedValidationErrors

Validation errors nested by field. Some endpoints return only `errors` or only `field-errors`.

- `errors` (list of string, optional) — Errors that don't apply to a single field.
- `field-errors` (map from string to any, optional) — Errors keyed by field name. Each value is a message, a list of messages, or a nested object of the same shape for nested fields.

### ApiKeyError

The API key lacks the scope the request requires, or is inactive.

- `error` (string, required)
- `error_code` (enum, required)
  - Allowed values: `insufficient_scope`, `inactive_api_key`
- `required_scope` (string, optional) — API key scope the request requires. Present when `error_code` is `insufficient_scope`.

### RateLimitErrorError

- `message` (string, required, nullable)
- `rate_reset` (string, required) — Number of seconds until the rate limit resets.
- `allowed_limit` (integer, optional) — Maximum number of bulk actions allowed. Present when the bulk action limit was hit.
- `bulk_action_count` (integer, optional) — Number of bulk actions running. Present when the bulk action limit was hit.

### ValidationErrorsErrorsItems

- `field` (list of ValidationErrorsErrorsItemsFieldItems, required) — Path of the invalid field. Empty for errors that don't apply to a field.
- `msg` (string, required)

### ValidationErrorsErrorsItemsFieldItems

- integer
- string

## Examples

**Request**

```json
{
  "plural": "Accounts",
  "singular": "Account"
}
```

**Response**

```json
{
  "is_customized": true,
  "label_type": "lead",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "plural": "Accounts",
  "singular": "Account"
}
```

**SDK Code**

```python standard_object_labels_update_example
import requests

url = "https://api.close.com/api/v1/standard_object_label/label_type/"

payload = {
    "plural": "Accounts",
    "singular": "Account"
}
headers = {
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers, auth=("<CLOSE_API_KEY>", ""))

print(response.json())
```

```javascript standard_object_labels_update_example
const url = 'https://api.close.com/api/v1/standard_object_label/label_type/';
const credentials = btoa("<CLOSE_API_KEY>:");

const options = {
  method: 'PUT',
  headers: {Authorization: `Basic ${credentials}`, 'Content-Type': 'application/json'},
  body: '{"plural":"Accounts","singular":"Account"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go standard_object_labels_update_example
package main

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

func main() {

	url := "https://api.close.com/api/v1/standard_object_label/label_type/"

	payload := strings.NewReader("{\n  \"plural\": \"Accounts\",\n  \"singular\": \"Account\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.SetBasicAuth("<CLOSE_API_KEY>", "")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby standard_object_labels_update_example
require 'uri'
require 'net/http'

url = URI("https://api.close.com/api/v1/standard_object_label/label_type/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request.basic_auth("<CLOSE_API_KEY>", "")
request["Content-Type"] = 'application/json'
request.body = "{\n  \"plural\": \"Accounts\",\n  \"singular\": \"Account\"\n}"

response = http.request(request)
puts response.read_body
```

```java standard_object_labels_update_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.close.com/api/v1/standard_object_label/label_type/")
  .basicAuth("<CLOSE_API_KEY>", "")
  .header("Content-Type", "application/json")
  .body("{\n  \"plural\": \"Accounts\",\n  \"singular\": \"Account\"\n}")
  .asString();
```

```php standard_object_labels_update_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.close.com/api/v1/standard_object_label/label_type/', [
  'body' => '{
  "plural": "Accounts",
  "singular": "Account"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
    'auth' => ['<CLOSE_API_KEY>', ''],
]);

echo $response->getBody();
```

```csharp standard_object_labels_update_example
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://api.close.com/api/v1/standard_object_label/label_type/");
client.Authenticator = new HttpBasicAuthenticator("<CLOSE_API_KEY>", "");
var request = new RestRequest(Method.PUT);

request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"plural\": \"Accounts\",\n  \"singular\": \"Account\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```