ZapAPI Docs
Get StartedConceptsAI GatewayGuidesPayment GatewaySDKAPI ReferenceResources
ApiUsers

Update a user

PATCH
/api/v1/users/{id}

Updates an existing user. All fields are optional. Cache is invalidated after update.

Authorization

bearer

Path Parameters

id*string

User UUID

Header Parameters

X-API-Version?string

API version for header-based versioning

Default"1"
Value in"1""2"

Request Body

application/json
  1. body
email?string

User email address

firstName?string

User first name

Length2 <= length <= 50
lastName?string

User last name

Length2 <= length <= 50
password?string

User password (optional - temporary password generated if not provided)

Length8 <= length <= 100
isActive?boolean

User active status

avatarUrl?string

Avatar image URL (Vercel Blob)

Response Body

User has been successfully updated.

response?unknownapplication/json
Example Request
curl -X PATCH 'http://localhost:3001/api/v1/users/6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "status": "success",  "statusCode": 200,  "message": "User updated successfully",  "data": {    "id": "6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe",    "email": "john.updated@example.com",    "firstName": "John",    "lastName": "Doe",    "isActive": true,    "createdAt": "2026-01-27T10:23:22.983Z",    "updatedAt": "2026-01-27T10:30:00.000Z"  },  "meta": {    "user_id": "6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe",    "updated_at": "2026-01-27T10:30:00.000Z"  },  "timestamp": "2026-01-27T10:30:00.015Z",  "path": "/api/v1/users/6dd9ca2a-4a9f-4155-ad34-4cf6a575eebe"}