--- title: "Rename, archive or reactivate an option" method: PATCH path: "/v1/companies/{company_id}/custom-fields/{key}/options/{option_id}" tags: ["CompanyCustomFields"] --- # Rename, archive or reactivate an option `PATCH /v1/companies/{company_id}/custom-fields/{key}/options/{option_id}` ## Request - Base URL: `https://app.beel.es/api` - URL: `https://app.beel.es/api/v1/companies/{company_id}/custom-fields/{key}/options/{option_id}` - Auth: HTTP bearer Updates only the properties present in the body. Invoices already saved keep the text they were saved with: renaming or archiving an option never changes an invoice. - **Rename:** `value` replaces the text. If another option of the field in the same scope — the same customer, or the common options for a common one — is equivalent to the new text (ignoring case, accents and repeated spaces), the answer is `409` with `CUSTOM_FIELD_OPTION_DUPLICATE` and nothing changes. - **Archive or reactivate:** `is_archived`. Options are never deleted. ## Headers - `Idempotency-Key` string ## Request body - PatchCustomFieldOptionRequest: JSON Merge Patch of an option: an omitted property is left as it is. Neither property can be cleared. The customer an option belongs to cannot be changed. - `value` string: New text of the option. Leading and trailing spaces are removed. Invoices already saved keep the text they were saved with. - `is_archived` boolean: `true` archives the option, `false` reactivates it. ## Response `200` The option, updated. - CustomFieldOptionResponse: The envelope every successful JSON response of the BeeL. API is wrapped in. There are no bare resources in v1 and none are planned: the payload always hangs off `data`. - A **single resource** is an object in `data`. - A **collection** hangs off a named key inside `data`, together with its `pagination`, also inside `data` — `data: {invoices: [...], pagination: {...}}`. - A collection carries `pagination` unless its operation declares itself a **closed catalogue**: a fixed, bounded list with nothing to page through. The declaration is explicit in the operation; a missing `pagination` is never something to infer. - `GET /v1/accounts` pages by cursor (`data: {accounts: [...], next_cursor}`). It is a documented variant of pagination, not another envelope. Putting the array straight into `data` with `pagination` as its sibling is the shape a v2 would adopt; v1 is not being flipped to it. - `success` boolean, required - `data` object, required: A value of a custom field, offered when filling it in. An option belongs to one customer or, without `customer_id`, is common to every customer of the company. - `id` string, uuid, required: Unique identifier of the option. - `value` string, required: Text of the option, exactly as it is shown and copied onto an invoice. - `customer_id` string, uuid, nullable, required: Customer the option belongs to, or `null` for an option common to every customer. It is set when the option is created and never changes. - `is_archived` boolean, required: An archived option is no longer offered and is left out of listings unless `include_archived=true`. Invoices that already carry its text keep it. - `meta` ResponseMeta - `timestamp` string, date-time - `request_id` string ## Other responses - `400`: Bad request. From a dashboard session, a `BeeL-Environment` header whose value is not a known environment answers `ENVIRONMENT_HEADER_INVALID`, with the header named in `error.details` (`{"BeeL-Environment": "invalid"}`); it is never read as production. `BUSINESS_RULE_VIOLATION` is the generic answer to an operation the resource does not admit in its current state when that state has no code of its own. It carries no `details`; read the resource again before retrying. - `401`: Missing or invalid authentication. Like every other error, `message`/`detail` is localized according to `Accept-Language` (`es`, `en`, `ca`); defaults to English when the header is missing or asks for none of those. - `403`: Your account does not own or manage this company, or does not hold the required access over it. A company that does not exist answers the same way. That case answers `error.code` `ACTIVE_COMPANY_NOT_ACCESSIBLE`. - `404`: Two causes, told apart by `error.code`: `CUSTOM_FIELD_NOT_FOUND` (this company has no custom field with this `key`) and `CUSTOM_FIELD_OPTION_NOT_FOUND` (the field has no option with this `option_id`; an option of another field answers the same way). - `409`: `CUSTOM_FIELD_OPTION_DUPLICATE` — another option of this field in the same scope is equivalent to the new `value`, archived or not; nothing changed. Use that option instead, reactivating it if it is archived. The idempotency codes of `StateConflict` (`IDEMPOTENCY_KEY_PROCESSING`, `IDEMPOTENCY_KEY_MISMATCH`) and `CONCURRENT_MODIFICATION` share this status. - `422`: `VALIDATION_ERROR` — the body parses but a value is not acceptable. `details` is a flat map from the offending property's name (in the contract's `snake_case`, nested paths joined with a dot, e.g. `recipient.address.postal_code`) to a message describing what is wrong with it, one entry per property. When the rejected value is one outside an enum's vocabulary, `details` instead follows `FieldDeserializationError` (`field`, `invalid_value`, `allowed_values`). Two more codes share this status for a value that passes the contract but does not fit where it is stored: `VALUE_TOO_LONG` (a text longer than its column holds) and `VALUE_OUT_OF_RANGE` (a number outside what its column holds). Nothing was written. - `429`: Rate limit exceeded. `RATE_LIMIT_EXCEEDED` when the request rate of your credential is over its limit; `TOO_MANY_REQUESTS` when an email the operation sends is held back because too many went out to that recipient in a short time. Either way, retry after the `Retry-After` seconds. `QUOTA_EXCEEDED` is the other `429`: the operation would go over a quota of your plan for the current period (issued invoices, for instance). Retrying does not help until the quota resets or the plan changes. `error.details` carries `feature_code`, `current_usage`, `quota_limit` and `reset_date`, and `RateLimit-Reset` the seconds until the reset when it is known. - `500`: Internal server error - `default`: Any status code the operation does not list above. Every operation declares it, so a generated client always has a branch to fall into and never loses the cause of a failure it did not anticipate. This is where the transport-level answers land — `405`, `406`, `415` and `429` — together with any status a future version of the API starts returning. All of them carry the same error envelope as the codes listed explicitly, so `error.code` is what tells them apart: switching on the status code alone is not enough. See «Transport-level errors» in the API description for when each one is produced. A `402` carrying `SUBSCRIPTION_REQUIRED` lands here when the account has no active subscription. `error.details` says why and what to do: `current_status` (absent if it never had one), `required_permission` and `action`. A `503` carrying `SERVICE_UNAVAILABLE` lands here too, with a `Retry-After` header: a dependency of BeeL itself (the database, the email provider) was momentarily unavailable and nothing was done. Retry after those seconds. A `502` carrying `EXTERNAL_SERVICE_ERROR` also lands here: an outbound integration the operation depends on failed or did not answer in time. It is a transient condition — retry with the same `Idempotency-Key` where the operation accepts one. One exception to the envelope: a failure of the network edge that never reaches the application (`502`, `503`, `504`, `524`) is generated by Cloudflare and its body is not BeeL's — it may not even be JSON. Treat those as "no answer", and retry. --- [API](https://skmtc.dev/beel/apis/beel-public-api.md) · [All operations](https://skmtc.dev/beel/apis/beel-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/beel/apis/beel-public-api/revisions/ffbc0ae31f79?raw)