# Update configuration value

`PUT /v1/configuration/{name}`

Set a single configuration value. Not all configuration values can be updated so the list of accepted configuration variables is small.

Authentication (security requirement alternatives):

```json
[
  {
    "firefly_iii_auth": []
  },
  {
    "local_bearer_auth": []
  }
]
```

- firefly_iii_auth: oauth2. OAuth2 authorization code flow. Create a client on your installation's `/profile` page; it authorizes at `/oauth/authorize` and issues tokens at `/oauth/token` there. The URLs below are the demo site's. [How to use the API](https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/api/index.md) walks through it.
- local_bearer_auth: http (bearer). A Personal Access Token, sent as a bearer token. Create one on your installation under Options > Profile > OAuth > Personal Access Tokens.

Parameters:

- `X-Trace-Id` (header, string, uuid, optional) - Unique identifier associated with this request.
  Type: string, uuid
  
  Example:
  
  ```json
  "40c71bbb-c676-4f24-83cf-cc725d7d7a00"
  ```

- `name` (path, string, required) - The name of the configuration value you want to update.
  Type: string
  
  Schema: [ConfigValueUpdateFilter](https://sourcey-firefly.pages.dev/api/models/configvalueupdatefilter/index.md)
  
  enum: ["configuration.is_demo_site","configuration.permission_update_check","configuration.last_update_check","configuration.single_user_mode","configuration.enable_exchange_rates","configuration.use_running_balance","configuration.enable_external_map","configuration.enable_external_rates","configuration.allow_webhooks","configuration.valid_url_protocols"]

Request body: application/x-www-form-urlencoded (required)

JSON array with the necessary account information or key=value pairs. See the model for the exact specifications.

Type: object

Schema: [ConfigurationUpdate](https://sourcey-firefly.pages.dev/api/models/configurationupdate/index.md)

- `value` (required)
  Reference: [PolymorphicProperty](https://sourcey-firefly.pages.dev/api/models/polymorphicproperty/index.md); Type: PolymorphicProperty

Request body: application/json (required)

JSON array with the necessary account information or key=value pairs. See the model for the exact specifications.

Type: object

Schema: [ConfigurationUpdate](https://sourcey-firefly.pages.dev/api/models/configurationupdate/index.md)

- `value` (required)
  Reference: [PolymorphicProperty](https://sourcey-firefly.pages.dev/api/models/polymorphicproperty/index.md); Type: PolymorphicProperty

Responses:

- 200: New configuration value stored, result in response.

Content type: application/json

Type: object

Schema: [ConfigurationSingle](https://sourcey-firefly.pages.dev/api/models/configurationsingle/index.md)

- `data` (required)
  Reference: [Configuration](https://sourcey-firefly.pages.dev/api/models/configuration/index.md); Type: object

- 400: Bad request

Content type: application/json

Type: object

Schema: [BadRequestResponse](https://sourcey-firefly.pages.dev/api/models/badrequestresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "Bad Request"
  ```

- `exception` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "BadRequestHttpException"
  ```

- 401: Unauthenticated

Content type: application/json

Type: object

Schema: [UnauthenticatedResponse](https://sourcey-firefly.pages.dev/api/models/unauthenticatedresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "Unauthenticated"
  ```

- `exception` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "AuthenticationException"
  ```

- 404: Page not found

Content type: application/json

Type: object

Schema: [NotFoundResponse](https://sourcey-firefly.pages.dev/api/models/notfoundresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "Resource not found"
  ```

- `exception` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "NotFoundHttpException"
  ```

- 422: Validation error. The body will have the exact details.

Content type: application/json

Type: object

Schema: [ValidationErrorResponse](https://sourcey-firefly.pages.dev/api/models/validationerrorresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "The given data was invalid."
  ```

- `errors` (optional)
  Type: object
  
  - `email` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `force` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `blocked` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `field` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `role` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `blocked_code` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `name` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `type` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `iban` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `start` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `end` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `date` (optional)
    Type: array
    
    Items:
      Type: string, string

- 500: Internal exception

Content type: application/json

Type: object

Schema: [InternalExceptionResponse](https://sourcey-firefly.pages.dev/api/models/internalexceptionresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "Internal Exception"
  ```

- `exception` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "InternalException"
  ```

## Examples

### cURL

```bash
curl -X PUT 'https://firefly.example.com/api/v1/configuration/configuration.is_demo_site' \
  -H 'X-Trace-Id: 40c71bbb-c676-4f24-83cf-cc725d7d7a00' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --data-raw 'value=true'
```

### JavaScript

```javascript
const response = await fetch('https://firefly.example.com/api/v1/configuration/configuration.is_demo_site', {
  method: 'PUT',
  headers: {
    'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/x-www-form-urlencoded',
  },
  body: 'value=true',
});

const data = await response.text();
```

### Python

```python
import requests

response = requests.put(
    'https://firefly.example.com/api/v1/configuration/configuration.is_demo_site',
    data='value=true'.encode('utf-8'),
    headers={
        'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/x-www-form-urlencoded',
    },
)
print(response.text)
```