--- title: Edit User --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [User](https://developers.cloudflare.com/api/resources/user) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Edit User PATCH/user Edit part of your user details. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### Accepted Permissions (at least one required) `User Details Write` ##### Body ParametersJSONExpand Collapse country: optional string The country in which the user lives. maxLength30 [Link to this property](<#(resource)%20user%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20country%20%3E%20(schema)>) first\_name: optional string User’s first name maxLength60 [Link to this property](<#(resource)%20user%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20first_name%20%3E%20(schema)>) last\_name: optional string User’s last name maxLength60 [Link to this property](<#(resource)%20user%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20last_name%20%3E%20(schema)>) telephone: optional string User’s telephone number maxLength20 [Link to this property](<#(resource)%20user%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20telephone%20%3E%20(schema)>) zipcode: optional string The zipcode or postal code where the user lives. maxLength20 [Link to this property](<#(resource)%20user%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20zipcode%20%3E%20(schema)>) ##### ReturnsExpand Collapse

errors: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20user%20%3E%20(method)%20edit%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)

messages: array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20user%20%3E%20(method)%20edit%20%3E%20(network%20schema)%20%3E%20(property)%20messages>) success: true Whether the API call was successful. [Link to this property](<#(resource)%20user%20%3E%20(method)%20edit%20%3E%20(network%20schema)%20%3E%20(property)%20success>)

result: optional object {id, email, betas, 12 more }

id: string Identifier of the user. Link to this property email: string Current email address of the user. formatemail Link to this property betas: optional array of string Lists the betas that the user is participating in. Link to this property country: optional string The country in which the user lives. maxLength30 Link to this property first\_name: optional string User’s first name maxLength60 Link to this property has\_business\_zones: optional boolean Indicates whether user has any business zones Link to this property has\_enterprise\_zones: optional boolean Indicates whether user has any enterprise zones Link to this property has\_pro\_zones: optional boolean Indicates whether user has any pro zones Link to this property last\_name: optional string User’s last name maxLength60 Link to this property

organizations: optional array of Organization { id, name, permissions, 2 more }

id: optional string Identifier maxLength32 minLength32 Link to this property name: optional string Organization name. maxLength100 Link to this property permissions: optional array of Permission Access permissions for this User. Link to this property roles: optional array of string List of roles that a user has within an organization. Link to this property

status: optional Status Whether the user is a member of the organization or has an invitation pending.

One of the following: "member" Link to this property "invited" Link to this property

Link to this property

Link to this property suspended: optional boolean Indicates whether user has been suspended Link to this property telephone: optional string User’s telephone number maxLength20 Link to this property two\_factor\_authentication\_enabled: optional boolean Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication. Link to this property two\_factor\_authentication\_locked: optional boolean Indicates whether two-factor authentication is required by one of the accounts that the user is a member of. Link to this property zipcode: optional string The zipcode or postal code where the user lives. maxLength20 Link to this property

[Link to this property](<#(resource)%20user%20%3E%20(method)%20edit%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### Edit User HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/user \ -X PATCH \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \ -d '{ "country": "US", "first_name": "John", "last_name": "Appleseed", "telephone": "+1 123-123-1234", "zipcode": "12345" }' ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1", "email": "alice@example.com", "betas": [ "zone_level_access_beta" ], "country": "US", "first_name": "John", "has_business_zones": true, "has_enterprise_zones": true, "has_pro_zones": true, "last_name": "Appleseed", "organizations": [ { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "Cloudflare, Inc.", "permissions": [ "#zones:read" ], "roles": [ "All Privileges - Super Administrator" ], "status": "member" } ], "suspended": true, "telephone": "+1 123-123-1234", "two_factor_authentication_enabled": true, "two_factor_authentication_locked": true, "zipcode": "12345" } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1", "email": "alice@example.com", "betas": [ "zone_level_access_beta" ], "country": "US", "first_name": "John", "has_business_zones": true, "has_enterprise_zones": true, "has_pro_zones": true, "last_name": "Appleseed", "organizations": [ { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "Cloudflare, Inc.", "permissions": [ "#zones:read" ], "roles": [ "All Privileges - Super Administrator" ], "status": "member" } ], "suspended": true, "telephone": "+1 123-123-1234", "two_factor_authentication_enabled": true, "two_factor_authentication_locked": true, "zipcode": "12345" } } ```