Breadcrumbs

Обновление информации об аккаунте

Метод используется для изменения информации об аккаунте, к которому есть доступ у текущего пользователя. Для принятия соглашений см. Принятие соглашения для аккаунта.

PATCH {reseller_domain}/internal_api/accounts/{account_id}

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

Content-Type

header

string

Обязательный

Тип данных, передаваемых в запросе. Укажите application/vnd.api+json

Accept

header

string

Обязательный

Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json

X-Api-Locale

header

string

Опциональный

Двухбуквенный код языка данных в ответе

Authorization 

header

string

Обязательный

Действующий access token пользователя. Формат: Bearer <access token>

reseller_domain

path

string

Обязательный

Доменное имя реселлера

account_id

path

integer

Обязательный

ID аккаунта, информацию о котором нужно обновить

primary_name

form

string

Опциональный

Основное имя аккаунта. Например, название компании для юридического лица

first_name

form

string

Опциональный

Имя уполномоченного лица

last_name

form

string

Опциональный

Фамилия уполномоченного лица

middle_name

form

string

Опциональный

Отчество уполномоченного лица

email

form

string

Опциональный

Email уполномоченного лица

tech_user_id

form

integer

Опциональный

ID пользователя — контактного лица по техническим вопросам

bill_user_id

form

integer

Опциональный

ID пользователя — контактного лица по финансовым вопросам

country

form

string

Опциональный

Код страны

region

form

string

Опциональный

Почтовый индекс

city

form

string

Опциональный

Регион (Область)

street

form

string

Опциональный

Город

building

form

string

Опциональный

Улица

office

form

string

Опциональный

Дом

zip

form

string

Опциональный

Офис

phone

form

string

Опциональный

Номер телефона

custom_attributes

form

object

Опциональный

Список пар ключ-значение дополнительных атрибутов аккаунта, значения которых нужно обновить (см. Получение списка атрибутов аккаунта):

  • Если указан несуществующий ключ, новое значение атрибута игнорируется.

  • Если указано значение для ключа атрибута, недоступного для редактирования, новое значение атрибута игнорируется.

  • Чтобы задать пустое значение атрибута, укажите "".

  • Если указан ключ обязательного атрибута, новое значение должно быть непустым.

Допустимые значения ограничены в зависимости от типа атрибута:

  • Для атрибутов типа checkbox:

    • true — флажок установлен.

    • false — флажок не установлен.

  • Для атрибутов типа list — ключ одного из предустановленных значений.

manager_key

form

string

Опциональный

Ключ менеджера, к которому нужно привязать аккаунт. Параметр игнорируется, если аккаунт уже привязан к менеджеру, или указан менеджер в статусе Неактивный, или указано пустое значение.

mfa_required

form

bool

Опциональный

Признак обязательности использования MFA всеми пользователями аккаунта:

  • true — включить обязательное использования MFA для всех пользователей аккаунта.

  • false — выключить обязательное использования MFA для всех пользователей аккаунта.

Реселлер может принудительно включить использование MFA для всех аккаунтов. В этом случае управление обязательностью MFA недоступно.

Модель ответа

Модель ответа аналогична методу Получение информации об аккаунте.

Пример запроса

Bash
curl --location --request PATCH 'https://test.activeplatform.com/internal_api/accounts/1185' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \
--data-raw '{
    "data": {
        "attributes": {
            "primary_name": "",
            "first_name": "Rickey",
            "last_name": "Predovic",
            "middle_name": "Dillan",
            "email": "Esta76@example.net",
            "tech_user_id": "1650",
            "bill_user_id": "1650",
            "country": "AW",
            "region": "South Rafaela",
            "city": "Kayleeville",
            "street": "Nader Ways",
            "building": "",
            "office": "",
            "zip": "220100",
            "phone": "+463-663-7176",
            "custom_attributes": {
                "bank_account": "2300000000000"
            },
            "manager_key": ""
        }
    }
}'

Пример ответа

JSON
{
    "data": {
        "id": "1185",
        "type": "accounts",
        "attributes": {
            "created_at": "2020-10-05 T09:38:44.590785+0300",
            "name": "Rickey Dillan Predovic",
            "primary_name": "",
            "status": "active",
            "user_status": "active",
            "user_role": "admin",
            "trial": false,
            "account_type": {
                "id": 1562,
                "key": "personal",
                "name": "Personal"
            },
            "terms_and_conditions": {
                "confirmed": true,
                "url": "https://test.activeplatform.com/terms"
            },
            "microsoft_customer_agreement": {
                "confirmed": true,
                "url": "https://test.activeplatform.com/mca"
            },
            "usable_balance": 125000,
            "reseller_currency_iso_code": "USD",
            "account_class": {
                "id": 2712,
                "key": "postpay",
                "name": "Postpay",
                "payment_model": "postpay",
                "buy_with_negative_balance": true,
                "guaranteed_payment_limit": 1000,
                "guaranteed_payment_period": 7
            },
            "financial_blocking_threshold": 200,
            "finance_lock_date": null,
            "current_consumption": 0,
            "user_contract": {
                "last_name": "Predovic",
                "first_name": "Rickey",
                "middle_name": "Dillan",
                "email": "Esta76@example.net"
            },
            "contact_data": {
                "country": "AW",
                "zip": "220100",
                "region": "South Rafaela",
                "city": "Kayleeville",
                "street": "Nader Ways",
                "building": "",
                "office": "",
                "phone": "+463-663-7176"
            },
            "contact_users": {
                "main": {
                    "id": 1650,
                    "last_name": "Oberbrunner",
                    "first_name": "Minerva",
                    "middle_name": "",
                    "email": "Devante77@example.org"
                },
                "tech": {
                    "id": 1650,
                    "last_name": "Oberbrunner",
                    "first_name": "Minerva",
                    "middle_name": "",
                    "email": "Devante77@example.org"
                },
                "bill": {
                    "id": 1650,
                    "last_name": "Oberbrunner",
                    "first_name": "Minerva",
                    "middle_name": "",
                    "email": "Devante77@example.org"
                }
            },
            "custom_attributes": {
                "bank_account": "2300000000000",
                "invoice": true,
                "vendor_ccp": ""
            },
            "manager": null,
            "available_operations": {
                "join_payments": true,
                "top_up_balance": true,
                "create_guaranteed_payment": true,
                "invite_user": true
            },
            "work_permit_for_postpaid": "verification_not_performed",
            "mfa_required": true
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}