Salvar configurações do perfil

POST/api/crm/v2/profile.updatev2

operationId: profile.update

Atualiza parcialmente o perfil do usuário atual: apenas as chaves enviadas são processadas, os demais campos permanecem inalterados. Pode ser usado tanto para salvar um único campo quanto para salvar todo o formulário em uma única requisição.

Um valor vazio limpa o campo (name, telegram_user_id, telefone, photo). Se o valor for obrigatório, um valor vazio retorna o erro 118: timezone, language e telefone.

O email não é alterado aqui: a troca de login requer confirmação e possui endpoints separados: profile.request_email_change e profile.cancel_email_change.

Telefone é um par de chaves, ambos devem ser enviados juntos: enviar apenas um retorna o erro 117. Alterar a senha exige old_password (erro 128 se não corresponder), envia uma notificação por email e encerra todas as sessões do usuário, incluindo a atual: as credenciais foram alteradas, portanto é necessário fazer login novamente. Ativar 2FA requer um código otp válido, desativar não; otp_reset gera um novo segredo, mantém o 2FA desativado e retorna secret e qr para novo vínculo.

Autorização

api-token + language + role

Corpo da solicitação `multipart/form-data`

object

namestringpode ser nulo

Um valor vazio limpa o campo

Exemplo: John Smith

phone_format_idinteger (PhoneFormatId)

Código do país: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Exemplo: 1

phone_numberstringpode ser nulo

Somente junto com phone_format_id; o telefone é obrigatório

Exemplo: (952) 056-31-65

telegram_user_idstringpode ser nulo

Apenas números; um valor vazio limpa o campo

Exemplo: 476962294

timezonestring

Exemplo: Europe/Kaliningrad

languagestring

Exemplo: ru

photostring · binarypode ser nulo

O arquivo substitui o avatar; um campo de texto vazio o remove

passwordstring

Nova senha; somente junto com old_password

Exemplo: 987654321

old_passwordstring

Senha atual; obrigatório ao alterar a senha

Exemplo: 123456789

otp_enabledboolean

true ativa 2FA e requer otp, false desativa

Exemplo: true

otp_resetboolean

Emite um novo segredo 2FA; o 2FA permanece desativado até novo vínculo

Exemplo: false

otpstring

Código do segredo atual; obrigatório ao ativar 2FA e ao usar otp_reset

Exemplo: 192870

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

descriptionstring

Exemplo: Successfully saved

photostring

Existe, se o avatar foi substituído

Exemplo: data:image/jpeg;base64,/9j/4AAQSkZJRg...

secretstring

Está presente em otp_reset

Exemplo: KA2G2UKBHBBHKOJR

qrstring

Existe para otp_reset

Exemplo: https://api.qrserver.com/v1/create-qr-code/?data=otpauth%3A%2F%2Ftotp%2FFS%2520Admin%3Akalabunga82%40gmail.com%3Fsecret%3DKA2G2UKBHBBHKOJR%26issuer%3DFS%2520Admin&size=520x520&margin=15

curl -X POST 'https://foodsoul.pro/api/crm/v2/profile.update' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: partner' \
  -F 'name=John Smith' \
  -F 'phone_format_id=1' \
  -F 'phone_number=(952) 056-31-65' \
  -F 'telegram_user_id=476962294' \
  -F 'timezone=Europe/Kaliningrad' \
  -F 'language=ru' \
  -F 'photo=@file.jpg' \
  -F 'password=987654321' \
  -F 'old_password=123456789' \
  -F 'otp_enabled=true' \
  -F 'otp_reset=false' \
  -F 'otp=192870'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/profile.update', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'partner',
    ],
    'multipart' => [
        [
            'name' => 'name',
            'contents' => 'John Smith',
        ],
        [
            'name' => 'phone_format_id',
            'contents' => '1',
        ],
        [
            'name' => 'phone_number',
            'contents' => '(952) 056-31-65',
        ],
        [
            'name' => 'telegram_user_id',
            'contents' => '476962294',
        ],
        [
            'name' => 'timezone',
            'contents' => 'Europe/Kaliningrad',
        ],
        [
            'name' => 'language',
            'contents' => 'ru',
        ],
        [
            'name' => 'photo',
            'contents' => '<file>',
        ],
        [
            'name' => 'password',
            'contents' => '987654321',
        ],
        [
            'name' => 'old_password',
            'contents' => '123456789',
        ],
        [
            'name' => 'otp_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'otp_reset',
            'contents' => 'false',
        ],
        [
            'name' => 'otp',
            'contents' => '192870',
        ],
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const body = new FormData()
body.append("name", "John Smith")
body.append("phone_format_id", "1")
body.append("phone_number", "(952) 056-31-65")
body.append("telegram_user_id", "476962294")
body.append("timezone", "Europe/Kaliningrad")
body.append("language", "ru")
body.append("photo", "<file>")
body.append("password", "987654321")
body.append("old_password", "123456789")
body.append("otp_enabled", "true")
body.append("otp_reset", "false")
body.append("otp", "192870")

const response = await fetch("https://foodsoul.pro/api/crm/v2/profile.update", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner"
    },
    body,
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/profile.update",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
    },
    files={
        "name": [
            None,
            "John Smith",
        ],
        "phone_format_id": [
            None,
            "1",
        ],
        "phone_number": [
            None,
            "(952) 056-31-65",
        ],
        "telegram_user_id": [
            None,
            "476962294",
        ],
        "timezone": [
            None,
            "Europe/Kaliningrad",
        ],
        "language": [
            None,
            "ru",
        ],
        "photo": [
            None,
            "<file>",
        ],
        "password": [
            None,
            "987654321",
        ],
        "old_password": [
            None,
            "123456789",
        ],
        "otp_enabled": [
            None,
            "true",
        ],
        "otp_reset": [
            None,
            "false",
        ],
        "otp": [
            None,
            "192870",
        ],
    },
)
data = response.json()

Resposta 200

{
  "status": "success",
  "data": {
    "description": "Successfully saved",
    "photo": "data:image/jpeg;base64,/9j/4AAQSkZJRg...",
    "secret": "KA2G2UKBHBBHKOJR",
    "qr": "https://api.qrserver.com/v1/create-qr-code/?data=otpauth%3A%2F%2Ftotp%2FFS%2520Admin%3Akalabunga82%40gmail.com%3Fsecret%3DKA2G2UKBHBBHKOJR%26issuer%3DFS%2520Admin&size=520x520&margin=15"
  }
}

As solicitações são enviadas para foodsoul.pro — o host deste portal, não é possível escolher outro.

Salvar configurações do perfil

Autorização

Corpo da solicitação multipart/form-data

Respostas

Corpo da solicitação `multipart/form-data`