Update passwordless user

Update a user’s information. If the email or phoneNumber is set to null the previous value will be deleted. If they are not set (i.e., undefined/missing from the request), they are left as-is.

PUT/appid-{appId}/{tenantId}/recipe/user ⠀

Authorization

api-keyAPI key · headerrequired

The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.

Header parameters

ridstring

cdi-versionstring

X.Y of the X.Y.Z CDI version.

Request body

application/json

recipeUserIduserId

emailstring | null

phoneNumberstring | null

Responses

200update user's information

One of:

object

statusstring

Allowed:OKUNKNOWN_USER_ID_ERROREMAIL_ALREADY_EXISTS_ERRORPHONE_NUMBER_ALREADY_EXISTS_ERROR

object

statusstring

Allowed:EMAIL_CHANGE_NOT_ALLOWED_ERRORPHONE_NUMBER_CHANGE_NOT_ALLOWED_ERROR

reasonstring

400error code 400

string

401error code 401

string

404error code 404

string

500error code 500

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

ridheadercdi-versionheaderX.Y of the X.Y.Z CDI version.

Bodyapplication/json

recipeUserIdstringemailstringphoneNumberstring

Request

curl -X PUT "/appid-{appId}/{tenantId}/recipe/user ⠀" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "email": "[email protected]",
  "phoneNumber": "+14155552671"
}'

const response = await fetch("/appid-{appId}/{tenantId}/recipe/user ⠀", {
  method: "PUT",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "email": "[email protected]",
  "phoneNumber": "+14155552671"
})
});

import requests

response = requests.put(
    "/appid-{appId}/{tenantId}/recipe/user ⠀",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "email": "[email protected]",
  "phoneNumber": "+14155552671"
},
)

Response

{
  "status": "OK"
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"