v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB

Field Configuration

Update Field Configuration

Partially updates a field configuration. Only properties present on the body are modified (PATCH semantics). Field configurations belonging to other organizations return 404.

patch/field-configurations/{id}

Path parameters

idstring required

UUID of the field configuration.

Request body

namestring

New human-readable name. When present, trimmed; 1-128 characters.

teamsUUIDstring[]

Replacement list of team UUIDs this configuration is assigned to. When omitted, existing assignments are preserved.

allTeamsboolean nullable

When present, sets whether the configuration applies to every team in the organization.

Example request

{
  "name": "Renamed Discovery Questions",
  "teamsUUID": [
    "fe515723-fe2e-4959-a5fa-c4d3937fe7e4"
  ]
}

Response

Field configuration successfully updated.

Example response

{
  "data": {
    "uuid": "b9e1c0a0-5a3d-4a9c-9b1e-2d6f4b7a1c11",
    "name": "Enterprise Discovery Questions",
    "organizationUUID": "16b78cec-82ef-46d2-8213-5d3bb7d2571c",
    "teamsUUID": [
      "fe515723-fe2e-4959-a5fa-c4d3937fe7e4"
    ],
    "allTeams": false,
    "isDefaultTemplate": false
  }
}