---
updatedAt: 2026-04-20T19:23:47.000Z
---

# Modify a user profile

Updates a user profile.This operation only modifies attributes specified in the request. Any attributes not included in the request are left exactly as-is. Plural values are appended to an existing plural unless an ID is provided. In that case, the plural data matching the specified ID is replaced.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Entity and Entity Types",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}"
    }
  ],
  "paths": {
    "/entity.update": {
      "post": {
        "operationId": "post-entity-update",
        "summary": "Modify a user profile",
        "description": "Updates a user profile.This operation only modifies attributes specified in the request. Any attributes not included in the request are left exactly as-is. Plural values are appended to an existing plural unless an ID is provided. In that case, the plural data matching the specified ID is replaced.",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "example": {
                  "stat": "ok"
                },
                "schema": {
                  "type": "object",
                  "description": "Updates a user profile. This member only modifies attributes specified in the API call. Attributes not included in the operation are ignored and not deleted.\n",
                  "properties": {
                    "stat": {
                      "type": "string",
                      "enum": [
                        "OK",
                        "ERROR",
                        "FAIL"
                      ],
                      "description": "Status of the operation.\n"
                    }
                  }
                }
              }
            },
            "description": "Successful response\n"
          }
        },
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "properties": {
                  "created": {
                    "type": "string",
                    "description": "Timestamp indicating when the entity (user profile) was created. If the provided value is incorrect, the call fails.\n",
                    "example": "2021-12-31 18:54:59.900339 +0000"
                  },
                  "id": {
                    "type": "integer",
                    "description": "Unique identifier of the user record. This member is optional if you specify the `uuid` member or the `key_attribute` member.\n",
                    "example": 1218
                  },
                  "key_attribute": {
                    "type": "string",
                    "description": "Name of a unique attribute in the schema. This member is required unless you use the `uuid` member or the `id` parameter. If you use `key_attribute` to locate a user account your operation also needs to use the `key_value` member. The `key_attribute` member specifies the attribute you're searching on and `key_value` specifies the value you're searching for.\n",
                    "example": "email"
                  },
                  "key_value": {
                    "type": "string",
                    "description": "Value assigned to the `key_attribute` member. The `key_attribute` member provides a way to locate a user account without using the `id` member or the `uuid` member. Enclose any string values in quotes.\n",
                    "example": "karim.nair@mail.com"
                  },
                  "last_updated": {
                    "type": "string",
                    "description": "Timestamp generated the last time the user account was updated. If this value is present but incorrect, the operation fails.\n",
                    "example": "2021-12-31 18:54:59.900339 +0000"
                  },
                  "type_name": {
                    "type": "string",
                    "description": "Name of the entity type (user profile database) where the user profile is stored.\n",
                    "example": "user"
                  },
                  "uuid": {
                    "type": "string",
                    "description": "Unique identifier of the user record. Required unless you use  the `id` member or the `key_attribute` member.\n",
                    "example": "o9845abc-12ht-abcd-1kQ4-1lQ45abc9012"
                  },
                  "value": {
                    "type": "string",
                    "description": "Value to assign to the `attribute_name` parameter. If `attribute_name` references just one attribute you only need to supply a value. For example, `Fred`. If `attribute_name` references multiple values then use JSON to specify each attribute value. For example, to assign values to the `givenName` and the `familyName` attributes use the syntax `{\"givenName\":\"Bob\",\"familyName\":\"Smith\"}`.\n"
                  },
                  "include_record": {
                    "type": "boolean",
                    "description": "When `true`, the API response includes all the attributes and attribute values assigned to the newly created or updated record. Use this member if you need to work with record immediately after it's been created or modified. If `false` or not specified then, because of database replication issues, you might experience a brief delay before the record appears in searches or counts.        - $ref: parameters/attribute_name-2-query.yaml\n"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "samples-languages": [
      "curl",
      "python",
      "node"
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "externalDocs": {
    "url": "https://techdocs.akamai.com/identity-cloud-entity/reference",
    "description": "See documention for Akamai's Identity Cloud: Entity and EntityType API\n"
  }
}
```