Skip to main content
POST
Create a project

Authorizations

Authorization
string
header
required

Access token obtained from POST /auth (client_id + client_secret). Valid for 300 seconds.

Headers

X-Sub-Account
string

Reference of the sub-account the operation runs against. When omitted, the operation happens on the main account; the reserved value principal also resolves to the main account and is equivalent to omitting the header. Accepted on every endpoint except POST /auth and the /sub-accounts endpoints themselves, which always operate on the main account.

Possible errors: 404 SUB_ACCOUNT_NOT_FOUND, 403 SUB_ACCOUNT_FORBIDDEN, 403 SUB_ACCOUNT_SUSPENDED.

Requires the credential to have sub-account access enabled (Settings → Integration → API Credentials). It starts turned off and is not replaced by any permission, not even FULL_ACCESS: without it the response is 403 SUB_ACCOUNT_FORBIDDEN.

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

"loja-centro"

Body

application/json
name
string
required

Project name

Maximum string length: 255
Example:

"Minha Loja"

color
string
required

Project color in hexadecimal format

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

"#3B82F6"

description
string

Project description

Example:

"Loja virtual de eletrônicos"

logoUrl
string<uri>

Project logo URL

Example:

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

Response

Project created successfully

id
string<uuid>
required

Project ID

name
string
required

Project name

Example:

"Minha Loja"

color
string
required

Project color in hexadecimal format

Example:

"#3B82F6"

createdAt
string<date-time>
required

Creation date

description
string

Project description

Example:

"Loja virtual de eletrônicos"

logoUrl
string<uri>

Project logo URL

Example:

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