Skip to main content
POST
Criar um projeto

Autorizações

Authorization
string
header
obrigatório

Access token obtido no POST /auth (client_id + client_secret). Válido por 300 segundos.

Cabeçalhos

X-Sub-Account
string

Reference da subconta em que a operação deve ser executada. Quando omitido, a operação acontece na conta principal; o valor reservado principal também resolve para a conta principal e é equivalente a omitir o header. Aceito em todos os endpoints, exceto POST /auth e os próprios endpoints de /sub-accounts, que sempre operam na conta principal.

Erros possíveis: 404 SUB_ACCOUNT_NOT_FOUND, 403 SUB_ACCOUNT_FORBIDDEN, 403 SUB_ACCOUNT_SUSPENDED.

Exige que a credencial tenha o acesso a subcontas habilitado (Configurações → Integração → Credenciais de API). Ele nasce desligado e não é substituído por nenhuma permissão, nem por FULL_ACCESS: sem ele a resposta é 403 SUB_ACCOUNT_FORBIDDEN.

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
Exemplo:

"loja-centro"

Corpo

application/json
name
string
obrigatório

Nome do projeto

Maximum string length: 255
Exemplo:

"Minha Loja"

color
string
obrigatório

Cor do projeto em formato hexadecimal

Pattern: ^#[0-9A-Fa-f]{6}$
Exemplo:

"#3B82F6"

description
string

Descrição do projeto

Exemplo:

"Loja virtual de eletrônicos"

logoUrl
string<uri>

URL do logo do projeto

Exemplo:

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

Resposta

Projeto criado com sucesso

id
string<uuid>
obrigatório

ID do projeto

name
string
obrigatório

Nome do projeto

Exemplo:

"Minha Loja"

color
string
obrigatório

Cor do projeto em formato hexadecimal

Exemplo:

"#3B82F6"

createdAt
string<date-time>
obrigatório

Data de criação

description
string

Descrição do projeto

Exemplo:

"Loja virtual de eletrônicos"

logoUrl
string<uri>

URL do logo do projeto

Exemplo:

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