API

Αποθήκευση ρυθμίσεων προφίλ

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

Ενημερώνει μερικώς το προφίλ του τρέχοντος χρήστη: επεξεργάζονται μόνο τα περασμένα κλειδιά, τα υπόλοιπα πεδία δεν αλλάζουν. Κατάλληλο τόσο για αποθήκευση ενός πεδίου όσο και για αποθήκευση ολόκληρης της φόρμας με ένα αίτημα.
Κενή τιμή καθαρίζει το πεδίο (name, telegram_user_id, τηλέφωνο, photo). Αν η τιμή είναι υποχρεωτική, κενή τιμή επιστρέφει σφάλμα 118: timezone, language και τηλέφωνο.
Το email δεν αλλάζει εδώ: η αλλαγή login απαιτεί επιβεβαίωση, για αυτό υπάρχουν ξεχωριστά τα profile.request_email_change και profile.cancel_email_change.
Το τηλέφωνο είναι ζεύγος κλειδιών, αποστέλλονται μαζί: το ένα χωρίς το άλλο επιστρέφει σφάλμα 117. Η αλλαγή κωδικού απαιτεί old_password (σφάλμα 128 αν δεν ταιριάζει), αποστέλλει ειδοποίηση στο email και τερματίζει όλες τις συνεδρίες του χρήστη, συμπεριλαμβανομένης της τρέχουσας: τα διαπιστευτήρια άλλαξαν, επομένως απαιτείται νέα είσοδος. Η ενεργοποίηση 2FA απαιτεί σωστό κωδικό otp, η απενεργοποίηση όχι· το otp_reset εκδίδει νέο μυστικό, αφήνει το 2FA απενεργοποιημένο και επιστρέφει secret και qr για νέα σύνδεση.

Εξουσιοδότηση

api-token + language + role

Σώμα αιτήματος multipart/form-data

object
namestringμπορεί να είναι null

Κενή τιμή διαγράφει το πεδίο

Παράδειγμα: John Smith

phone_format_idinteger (PhoneFormatId)

Κωδικός χώρας: 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)

Παράδειγμα: 1

phone_numberstringμπορεί να είναι null

Μόνο μαζί με phone_format_id· το τηλέφωνο είναι υποχρεωτικό

Παράδειγμα: (952) 056-31-65

telegram_user_idstringμπορεί να είναι null

Μόνο αριθμοί· κενή τιμή διαγράφει το πεδίο

Παράδειγμα: 476962294

timezonestring

Παράδειγμα: Europe/Kaliningrad

languagestring

Παράδειγμα: ru

photostring · binaryμπορεί να είναι null

Το αρχείο αντικαθιστά το avatar· ένα κενό πεδίο κειμένου το διαγράφει

passwordstring

Νέος κωδικός πρόσβασης· μόνο μαζί με old_password

Παράδειγμα: 987654321

old_passwordstring

Τρέχων κωδικός πρόσβασης· απαιτείται για αλλαγή κωδικού πρόσβασης

Παράδειγμα: 123456789

otp_enabledboolean

true ενεργοποιεί το 2FA και απαιτεί otp, false το απενεργοποιεί

Παράδειγμα: true

otp_resetboolean

Εκδίδει νέο μυστικό 2FA· το 2FA παραμένει απενεργοποιημένο μέχρι τη νέα σύνδεση

Παράδειγμα: false

otpstring

Κωδικός τρέχοντος μυστικού· απαιτείται κατά την ενεργοποίηση του 2FA και κατά το otp_reset

Παράδειγμα: 192870

Απαντήσεις

OK

object
statusstringυποχρεωτικό

Τιμές:successerror

Παράδειγμα: success

dataobject
descriptionstring

Παράδειγμα: Successfully saved

photostring

Υπάρχει, αν το avatar έχει αντικατασταθεί

Παράδειγμα: data:image/jpeg;base64,/9j/4AAQSkZJRg...

secretstring

Υπάρχει όταν otp_reset

Παράδειγμα: KA2G2UKBHBBHKOJR

qrstring

Υπάρχει όταν otp_reset

Παράδειγμα: 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