Update Company by ID
Endpoint: PUT /companies/{id}
Authentication: Bearer Token (required)
Request
Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Authorization | string | Yes | Bearer token for authentication |
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | The unique identifier of the company to update |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | The updated name of the company (e.g. "Bookshop Borrowdale") |
| address | string | No | The updated physical or postal address of the company |
| abbr | string | No | The abbreviated name or short code for the company (e.g. "BB") |
| enableSandbox | boolean | No | Whether to enable sandbox/test mode for the company (e.g. true) |
| baseCurrencyString | string | Yes | The ISO currency code for the company's base currency (e.g. "USD") |
Request Schema
{
"headers": {
"Authorization": "Bearer <token>"
},
"path": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"body": {
"name": "Bookshop Borrowdale",
"address": "",
"abbr": "BB",
"enableSandbox": true,
"baseCurrencyString": "USD"
}
}