API

Uložit nastavení profilu

POST/api/crm/v2/profile.updatev2
operationId: profile.update

Částečně aktualizuje profil aktuálního uživatele: zpracovávají se pouze předané klíče, ostatní pole zůstávají beze změny. Vhodné jak pro uložení jednoho pole, tak pro uložení celého formuláře jedním požadavkem.
Prázdná hodnota pole vymaže (name, telegram_user_id, telefon, photo). Pokud je hodnota povinná, prázdná hodnota vrací chybu 118: timezone, language a telefon.
Email zde nelze změnit: změna přihlašovacího jména vyžaduje potvrzení, k tomu slouží samostatné operace profile.request_email_change a profile.cancel_email_change.
Telefon je dvojice klíčů, musí být předány společně: jeden bez druhého vrací chybu 117. Změna hesla vyžaduje old_password (chyba 128, pokud nesouhlasí), odešle oznámení na email a ukončí všechny uživatelské relace včetně aktuální: přihlašovací údaje byly změněny, je nutné se znovu přihlásit. Zapnutí 2FA vyžaduje správný kód otp, vypnutí ne; otp_reset vydá nový tajný klíč, ponechá 2FA vypnuté a vrátí secret a qr pro nové propojení.

Autorizace

api-token + language + role

Tělo požadavku multipart/form-data

object
namestringmůže být null

Prázdná hodnota pole vymaže

Příklad: John Smith

phone_format_idinteger (PhoneFormatId)

Kód země: 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)

Příklad: 1

phone_numberstringmůže být null

Pouze spolu s phone_format_id; telefon je povinný

Příklad: (952) 056-31-65

telegram_user_idstringmůže být null

Pouze číslice; prázdná hodnota pole vymaže

Příklad: 476962294

timezonestring

Příklad: Europe/Kaliningrad

languagestring

Příklad: ru

photostring · binarymůže být null

Soubor nahradí avatar; prázdné textové pole jej odstraní

passwordstring

Nové heslo; pouze spolu s old_password

Příklad: 987654321

old_passwordstring

Aktuální heslo; povinné při změně hesla

Příklad: 123456789

otp_enabledboolean

true povolí 2FA a vyžaduje otp, false ji vypne

Příklad: true

otp_resetboolean

Vydává nový 2FA secret; 2FA zůstává vypnuté až do nového propojení

Příklad: false

otpstring

Kód aktuálního tajného klíče; povinné při aktivaci 2FA a při otp_reset

Příklad: 192870

Odpovědi

OK

object
statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject
descriptionstring

Příklad: Successfully saved

photostring

Je-li avatar změněn

Příklad: data:image/jpeg;base64,/9j/4AAQSkZJRg...

secretstring

Je při otp_reset

Příklad: KA2G2UKBHBBHKOJR

qrstring

Je při otp_reset

Příklad: 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