Skip to main content
POST
Criar um projeto

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Payload obrigatório para criação de um projeto

name
string
required

Nome do projeto. Campo obrigatório na criação, máximo de 191 caracteres.

Maximum string length: 191
Example:

"Novo Projeto"

description
string

Descrição detalhada do projeto. Campo opcional que permite fornecer informações adicionais sobre o projeto.

Example:

"Descrição do projeto"

impact
integer

Nível de impacto do projeto em uma escala de 1 a 10.

Required range: 1 <= x <= 10
Example:

5

contact_id
string<uuid>

ID único (UUID) do contato associado ao projeto. Campo opcional que permite vincular um contato específico ao projeto.

Example:

"uuid-do-contato"

customer_id
string<uuid>

ID único (UUID) do cliente associado ao projeto. Campo opcional que permite vincular um cliente específico ao projeto.

Example:

"uuid-do-cliente"

status
enum<number>

Status atual do projeto. Valores possíveis: 1 (Em execução), 2 (Concluído), 3 (Arquivado), 4 (Parado).

Available options:
1,
2,
3,
4
Example:

1

budget
number<float>

Receita esperada do projeto em valor numérico decimal. Campo opcional que permite definir a receita esperada para o projeto. Valor mínimo: 0, máximo: 999999999999.99.

Example:

15000.5

is_template
boolean

Indica se o projeto é um modelo de projeto. Quando true, o projeto pode ser usado como base para criação de outros projetos.

Example:

false

form_answers
object[]

Array de objetos contendo as respostas de formulários dinâmicos associados ao projeto. Cada objeto contém os dados das respostas dos campos do formulário.

forecast_dates
object[]

Array de objetos para definir datas de previsão por funil. Permite associar diferentes datas de previsão a diferentes funis de projeto.

groups
object

Objeto para gerenciar grupos associados ao projeto. Contém arrays 'to_add' e 'to_rem' para adicionar ou remover grupos.

tags
object

Objeto para gerenciar etiquetas de funil associadas ao projeto. Contém arrays 'to_add' e 'to_rem' para adicionar ou remover etiquetas do projeto.

funnels
object

Objeto para gerenciar funis que o projeto está vinculado. Contém arrays 'to_add' e 'to_rem' para adicionar ou remover funis.

funnel_status
object

Objeto para vincular ou desvincular um status de funil do projeto.

prefix
string

Prefixo para o código do projeto. Quando fornecido, será usado na geração automática do código do projeto (ex: 'PRJ-001').

Example:

"PRJ"

users
object[]

Array de objetos para gerenciar usuários associados ao projeto.

childrens
object

Objeto para gerenciar projetos filhos associados ao projeto. Contém arrays 'to_add' e 'to_rem' para adicionar ou remover projetos filhos.

parent_id
string<uuid> | null

ID do projeto pai na hierarquia. Quando null, o projeto fica na raiz.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Sucesso

response
boolean
project
object