Appearance

update-user ​

Method: PUT
Path: /auth/user/{id}

Tags: Auth

Summary ​

Update a user

Description ​

The Update User API helps to efficiently modify and enhance user information within the system, ensuring that user profiles remain accurate and up-to-date. This API provides a secure and flexible mechanism for updating specific details while maintaining adherence to established conventions.

Storefront SDK Usage ​

SDK Method: sdk.auth.updateUserDetails()

Example:

typescript
// Update user profile information
const { data, error } = await sdk.auth.updateUserDetails(
  { id: "01H9XYZ12345USERID" },
  {
    first_name: "John",
    last_name: "Doe",
    email: "john.doe@example.com",
    phone: "9876543210",
    country_code: "+91"
  }
);

if (error) {
  console.error("Failed to update user:", error.message);
} else {
  console.log("User updated successfully:", data.user.first_name);
}

TypeScript Definition ​

typescript
"update-user": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description user ID */
                id: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": components["schemas"]["User"];
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        /** @description A descriptive message confirming the success or failure of the Registration process. */
                        message: string;
                        /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
                        success: boolean;
                        /** @description An object containing the response content. */
                        content: {
                            /** @description An object containing the response content. */
                            user: components["schemas"]["User"];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
        };
    };

Component References ​

ReferenceResolves To
components["schemas"]["User"]User
components["responses"]["BadRequest"]BadRequest
components["responses"]["Unauthorized"]Unauthorized

Parameters ​

  • id (path): user ID

Request Body ​

Content Types: application/json

Responses ​

200 ​

OK

400 ​

Bad request

401 ​

Not authorized for given operation on the Resource

OpenAPI Definition ​

json
{
  "tags": [
    "Auth"
  ],
  "operationId": "update-user",
  "summary": "Update a user",
  "description": "The Update User API helps to efficiently modify and enhance user information within the system, ensuring that user profiles remain accurate and up-to-date. This API provides a secure and flexible mechanism for updating specific details while maintaining adherence to established conventions.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/update-user",
    "description": "API reference for the update-user operation"
  },
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "user ID",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "description": "",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User"
            }
          ]
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "description": "A descriptive message confirming the success or failure of the Registration process.",
                "type": "string"
              },
              "success": {
                "description": "Indicates whether the request was successful or failure (true for success, false for failure).",
                "type": "boolean"
              },
              "content": {
                "description": "An object containing the response content.",
                "properties": {
                  "user": {
                    "description": "An object containing the response content.",
                    "$ref": "#/components/schemas/User"
                  }
                },
                "required": [
                  "user"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "auth",
  "x-speakeasy-ignore": false,
  "x-speakeasy-name-override": "updateUser"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: