Sign in
v1
User

Update User

Update user details by user_id (_User.objectId) and developer association

put/v1/user/{user_id}

Path parameters

user_idstring required

Headers

X-API-Keystring required

Request body

emailstring nullable
external_idstring nullable
metadataobject nullable
type'developerUser' | 'user' | 'agent'

Example request

{
  "email": "updated.user@example.com",
  "external_id": "updated_user_123",
  "metadata": {
    "name": "Updated User",
    "preferences": {
      "theme": "light"
    }
  },
  "type": "developerUser"
}

Response

Successful Response

codeinteger required

HTTP status code

statusstring required

'success' or 'error'

user_idstring nullable
emailstring nullable
external_idstring nullable
metadataobject nullable
created_atstring nullable
updated_atstring nullable
errorstring nullable
{"stackTrail":"components:schemas:UserResponse:properties:details:anyOf","oasType":"schema","type":"unknown","title":"Details","nullable":true}

Example response

{
  "code": 200,
  "created_at": "2024-03-20T10:00:00.000Z",
  "email": "user@example.com",
  "external_id": "user123",
  "metadata": {
    "name": "John Doe",
    "preferences": {
      "theme": "dark"
    }
  },
  "status": "success",
  "updated_at": "2024-03-20T10:00:00.000Z",
  "user_id": "abc123"
}

Changes

Changed in 1 of the 37 revisions of this API.2

  • 0e4854909d2a2See the full diff
    • ○

      added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added