---
title: "Update a custom field"
method: PATCH
path: "/fields/{key}"
tags: ["Custom fields"]
---

# Update a custom field

`PATCH /fields/{key}`

## Request

- Base URL: `https://api.rizamo.com/v1`
- URL: `https://api.rizamo.com/v1/fields/{key}`
- Auth: HTTP bearer

The key and type cannot change. Removing an option leaves the value on posts that have it.

## Path parameters

- `key` string, required: The field's key, such as campaign.

## Request body

- object
  - `label` string: A new name for people, up to 60 characters.
  - `options` string[]: A select or multi_select field's choices as they should be, every one of them. A choice left out stays on the posts that have it.
  - `description` string, nullable: What the field is for; null removes it.

## Response `200`

OK

- FieldDefinition
  - `key` string, required
  - `entity` 'post', required
  - `label` string, required
  - `type` 'text' | 'select' | 'multi_select' | 'number' | 'url' | 'date' | 'checkbox', required
  - `options` string[]
  - `description` string

## Other responses

- `400`: `invalid_request`: A field is missing or wrong, or the request cannot be done as asked: the message names the field or says what to change.
- `401`: `unauthorized`: No API key or sign-in, or the key does not work: it was deleted, or it expired.
- `403`: `forbidden`: The caller may not do this: the key or agent lacks the scope (the message names it), or the action needs another role or a fresh sign-in.
- `404`: `not_found`: No such object, or it is outside your team or the profiles your key reaches.
- `409`: `conflict`: The object's state does not allow it now, such as an account that needs a new login. `queue_empty`: A post with `queue: true` whose profile has no posting times: set them, or give a `scheduledAt`. `queue_full`: No posting time free for the post's accounts in the next 90 days: add times, or give a `scheduledAt`. `idempotency_key_in_use`: A request with this `Idempotency-Key` is still running: try again in a moment.
- `413`: `payload_too_large`: The body is over 1 MB: files go up through the upload links of `POST /v1/media`.
- `415`: `unsupported_media_type`: The body is not JSON: send it with `Content-Type: application/json`.
- `429`: `rate_limited`: Over one of Rizamo's limits, or a network asked Rizamo to slow down: wait for `Retry-After` seconds, or as long as the message says.
- `500`: `internal`: Our side failed: retry, and send the `requestId` if it keeps failing.
- `503`: `timeout`: The request took too long to work out, most often a report: try again in a moment, or ask a report for a shorter period or one profile.

---

[API](https://skmtc.dev/rizamo/apis/rizamo-api.md) - [All operations](https://skmtc.dev/rizamo/apis/rizamo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rizamo/apis/rizamo-api/revisions/31b0c1b1ffb5?raw)
