---
title: "Update field"
method: PUT
path: "/v1/accounts/{accountId}/fields/{fieldId}"
tags: ["Fields"]
---

# Update field

`PUT /v1/accounts/{accountId}/fields/{fieldId}`

## Request

- Base URL: `https://api.assinafy.com.br`
- URL: `https://api.assinafy.com.br/v1/accounts/{accountId}/fields/{fieldId}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

Update a field definition.

[Copy as Markdown](https://api.assinafy.com.br/v1/docs/markdown?method=put&path=%2Fv1%2Faccounts%2F%7BaccountId%7D%2Ffields%2F%7BfieldId%7D) [Open in ChatGPT](https://chatgpt.com/?q=Read%20the%20API%20documentation%20at%20https%3A%2F%2Fapi.assinafy.com.br%2Fv1%2Fdocs%2Fmarkdown%3Fmethod%3Dput%26path%3D%252Fv1%252Faccounts%252F%257BaccountId%257D%252Ffields%252F%257BfieldId%257D%20and%20help%20me%20integrate%20this%20endpoint.) [Open in Claude](https://claude.ai/new?q=Read%20the%20API%20documentation%20at%20https%3A%2F%2Fapi.assinafy.com.br%2Fv1%2Fdocs%2Fmarkdown%3Fmethod%3Dput%26path%3D%252Fv1%252Faccounts%252F%257BaccountId%257D%252Ffields%252F%257BfieldId%257D%20and%20help%20me%20integrate%20this%20endpoint.)

## Path parameters

- `accountId` string, required
- `fieldId` string, required

## Request body

- object
  - `name` string
  - `regex` string, nullable
  - `is_active` boolean

## Response `200`

The updated field

- object: Standard success wrapper. Operations add their own `data`.
  - `status` integer: HTTP status code, mirrored in the body.
  - `message` string: Human-readable message; empty on success.
  - `data` Field: A reusable field definition.
    - `resource` string
    - `id` string
    - `name` string
    - `type` string
    - `regex` string, nullable
    - `is_pre_defined` boolean
    - `is_active` boolean
    - `is_required` boolean
    - `is_standard` boolean
    - `is_read_only` boolean
    - `is_visible` boolean

## Other responses

- `401`: Missing or invalid credentials.
- `404`: The requested resource does not exist.
- `500`: Unexpected server error.

---

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