---
updatedAt: 2026-04-20T19:34:00.000Z
---

# Modify a field

Updates or replaces a field in the flow.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Flows",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}"
    }
  ],
  "paths": {
    "/config/{app_id}/flows/{flow}/fields/{field}": {
      "put": {
        "operationId": "put-field",
        "summary": "Modify a field",
        "description": "Updates or replaces a field in the flow.",
        "requestBody": {
          "content": {
            "application/json": {
              "example": {
                "type": "text",
                "name": "myCustomTextField",
                "schemaAttribute": "displayName",
                "socialProfileData": "profile.displayName",
                "label": {
                  "key": "b6ced670-7140-4446-9839-da3474860b1a"
                },
                "tip": {
                  "key": "8b93448a-6f00-448c-952b-0f1536107cf7"
                },
                "placeholder": {
                  "key": "6e15067b-2ca5-43c3-af96-930766d63375"
                },
                "validation": [
                  {
                    "rule": "required",
                    "value": true,
                    "message": {
                      "key": "bb2b21a1-98df-4dce-84f7-534013c46225"
                    }
                  },
                  {
                    "rule": "unique",
                    "value": true,
                    "message": {
                      "key": "63f7c18f-521a-4b4f-94c4-0b04b870c82e"
                    }
                  }
                ]
              },
              "schema": {
                "type": "object",
                "description": "Updates a field in the flow.\n",
                "required": [
                  "type",
                  "name",
                  "schemaAttribute"
                ],
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "text",
                      "email",
                      "password",
                      "checkbox",
                      "radio",
                      "select",
                      "textarea",
                      "dateselect",
                      "readonly",
                      "hidden",
                      "multiIdentifierAuth"
                    ],
                    "description": "Type of field. After a field has been created, the field type can’t be changed.\n"
                  },
                  "name": {
                    "type": "string",
                    "description": "Unique name assigned to the field.\n"
                  },
                  "schemaAttribute": {
                    "type": "string",
                    "description": "User profile attribute assigned to a field. For example, a field named `firstName` might be associated with the `givenName` attribute.\n"
                  },
                  "label": {
                    "type": "string",
                    "description": "Optional label used when the field appears on an Identity Cloud screen. Labels need to reference a translation identifier.\n"
                  },
                  "tip": {
                    "type": "string",
                    "description": "Optional tooltip used when the field appears on an Identity Cloud screen. Tooltips need to reference a translation identifier.\n"
                  },
                  "socialProfileData": {
                    "type": "string",
                    "description": "Specifies the data returned following a social identity login that can be used to populate the value of this field. For example, the syntax `profile.emailAddress` indicates that the `emailAddress` property returned from the social identity provider can be used as the value for this field.\n"
                  },
                  "placeholder": {
                    "type": "string",
                    "description": "HTML `placeholder` attribute when the field appears on an Identity Cloud screen. The `placeholder` is sample text that appears in a field, but then disappears as soon as the user begins to type in that field.\n"
                  },
                  "validation": {
                    "type": "array",
                    "description": "Validations assigned to a field. Validations help verify field data before writing that information to the user profile. For example, a validation might ensure that you don’t attempt to write string data to an attribute that can only accept integer data.\n",
                    "items": {
                      "type": "object",
                      "properties": {
                        "rule": {
                          "description": "Validation rule assigned to the field.\n",
                          "type": "string",
                          "enum": [
                            "blacklist",
                            "emailDomainsBlacklist",
                            "format",
                            "match",
                            "matchOptions",
                            "maxLength",
                            "minLength",
                            "minYears",
                            "required",
                            "unique",
                            "disableClientSide",
                            "alongWith",
                            "whitelist",
                            "clientFunctionName",
                            "serverRegexSetting"
                          ]
                        },
                        "value": {
                          "type": "string",
                          "description": "Value to validate against.\n"
                        },
                        "message": {
                          "type": "string",
                          "description": "Error message displayed if the validation fails. This needs to be a reference to a translation identifier.\n"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "Successfully modified.\n"
          },
          "404": {
            "content": {
              "application/json": {
                "example": {
                  "$ref": "#/paths/~1config~1%7Bapp_id%7D~1flows/get/responses/404/content/application~1json/example"
                },
                "schema": {
                  "$ref": "#/paths/~1config~1%7Bapp_id%7D~1flows/get/responses/404/content/application~1json/schema"
                }
              }
            },
            "description": "Flow not found.\n"
          }
        }
      },
      "parameters": [
        {
          "$ref": "#/paths/~1config~1%7Bapp_id%7D~1flows/parameters/0"
        },
        {
          "description": "Name of the field.\n",
          "in": "path",
          "name": "field",
          "required": true,
          "schema": {
            "type": "string"
          }
        },
        {
          "$ref": "#/paths/~1config~1%7Bapp_id%7D~1flows~1%7Bflow%7D/parameters/1"
        }
      ]
    }
  },
  "x-readme": {
    "samples-languages": [
      "curl",
      "python",
      "node"
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "externalDocs": {
    "url": "https://techdocs.akamai.com/identity-cloud-config/reference",
    "description": "See documention for Akamai's Identity Cloud: Configuration API\n"
  }
}
```

# Sibling pages

* [Remove a field from a flow](https://techdocs.akamai.com/identity-cloud-config/reference/delete-field.md)
* [Get a specific field](https://techdocs.akamai.com/identity-cloud-config/reference/get-field.md)