Pular para o conteúdo principal

updateUser

Atualizando um único objeto de usuário 🔐 Este método requer autorização.

Users.updateUser(body, langCode)

const body = {
"formIdentifier": "reg",
"authData": [
{
"marker": "password",
"value": "12345"
}
],
"formData": [
{
"marker": "last_name",
"type": "string",
"value": "Username"
}
],
"notificationData": {
"email": "example@oneentry.cloud",
"phonePush": ["+99999999999"],
"phoneSMS": "+99999999999"
},
"state": {
"orderCount": 1
}
}

const value = await Users.updateUser(body)
Esquema

body:* objeto
Corpo da requisição
exemplo:

langCode: string
Campo de idioma opcional
exemplo: en_US


Esquema (body)

formIdentifier string
o identificador de texto do formulário vinculado ao provedor de autorização
exemplo: , regForm

formData: FormDataLangType
os dados do formulário vinculados ao provedor de autorização
exemplo:

{
"en_US": [
{
"marker": "first-name",
"value": "Primeiro nome"
},
{
"marker": "last-name",
"value": "Sobrenome"
}
]
}

authData FormDataType
Dados de autorização retirados do formulário vinculado ao provedor de autorização (usado apenas para alterar a senha)
exemplo:

[
{
"marker": "password",
"value": "12345"
}
]

notificationData UserNotificationDataType
Dados para notificar o usuário
exemplo:

{
"email": "<example@oneentry.cloud>",
"phonePush": "",
"phoneSMS": "+9999999999"
}

Este método atualiza o objeto de dados do usuário autorizado. Retorna true (em caso de atualização bem-sucedida) ou false (em caso de atualização malsucedida).

Exemplo de retorno:

true