Skip to main content
POST
Создать проект

Авторизации

Authorization
string
header
обязательно

Токен доступа, полученный через POST /auth (client_id + client_secret). Действителен в течение 300 секунд.

Заголовки

X-Sub-Account
string

Reference субсчёта, в котором должна выполняться операция. Если заголовок не передан, операция выполняется в основном аккаунте; зарезервированное значение principal также указывает на основной аккаунт и равнозначно отсутствию заголовка. Принимается всеми эндпоинтами, кроме POST /auth и самих эндпоинтов /sub-accounts, которые всегда работают с основным аккаунтом.

Возможные ошибки: 404 SUB_ACCOUNT_NOT_FOUND, 403 SUB_ACCOUNT_FORBIDDEN, 403 SUB_ACCOUNT_SUSPENDED.

Требует, чтобы у учётных данных был включён доступ к субсчетам (Настройки → Интеграция → Учётные данные API). По умолчанию он выключен и не заменяется никаким разрешением, даже FULL_ACCESS: без него ответ — 403 SUB_ACCOUNT_FORBIDDEN.

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
Пример:

"loja-centro"

Тело

application/json
name
string
обязательно

Название проекта

Maximum string length: 255
Пример:

"Minha Loja"

color
string
обязательно

Цвет проекта в шестнадцатеричном формате

Pattern: ^#[0-9A-Fa-f]{6}$
Пример:

"#3B82F6"

description
string

Описание проекта

Пример:

"Loja virtual de eletrônicos"

logoUrl
string<uri>

URL логотипа проекта

Пример:

"https://example.com/logo.png"

Ответ

Проект успешно создан

id
string<uuid>
обязательно

ID проекта

name
string
обязательно

Название проекта

Пример:

"Minha Loja"

color
string
обязательно

Цвет проекта в шестнадцатеричном формате

Пример:

"#3B82F6"

createdAt
string<date-time>
обязательно

Дата создания

description
string

Описание проекта

Пример:

"Loja virtual de eletrônicos"

logoUrl
string<uri>

URL логотипа проекта

Пример:

"https://example.com/logo.png"