E aí! Precisa de ajuda?

API CRM: Criar um novo item no funil

Criar um novo item em um funil do CRM

Daniel TeixeiraAlterado em: 29/01/2025

Campos permitidos

NomeDescriçãoTipoObrigatórioPadrão
accountIdID da contanumberSim-
pipeIdID do funilnumberSim-
createdByUserIdID do usuário que criounumberSim-
organizationIdID da empresanumberNão-
pipeStepIdID da etapanumberSim-
userIdID do usuário responsávelnumberSim-
contactIdID do contatonumberSim-
titleTítulostringSim-
descriptionDescriçãostringNão-
closingForecastDateData prevista para fechamentostringNão-
valueValornumberNão-
recurringValueValor recorrentenumberNão-
pipeOriginIdID da origemnumberNão-
statusSituação (inProgress, won, lost)PipeItemStatusNãoinProgress
priorityPrioridade (0,1,2,3,4,5)numberSimSem prioridade (0)

Como criar um novo item no funil

Para criar um novo item no funil, é necessário fornecer os seguintes campos obrigatórios:

  • accountId: Identificador da conta associada.
  • pipeId: Identificador do pipe onde o item será criado.
  • createdByUserId: Identificador do usuário que está criando o item.
  • pipeStepId: Identificador do estágio no pipe.
  • userId: Identificador do usuário relacionado ao item.
  • contactId: Identificador do contato relacionado ao item.
  • title: Título do pipe item.
  • priority: Prioridade atribuída ao item.

Explicação dos campos opcionais

  • organizationId: Identificador da organização associada ao item.
  • description: Descrição adicional do item.
  • closingForecastDate: Data estimada de fechamento do item (ISO 8601).
  • value: Valor financeiro associado ao item.
  • recurringValue: Valor recorrente associado ao item.
  • pipeOriginId: Identificador do pipe de origem.
  • status: Estado atual do item (inProgress, won ou lost).

Observação: Esses campos devem ser enviados no corpo da requisição em formato JSON. Certifique-se de incluir um token de autorização válido no cabeçalho da requisição.

Exemplos

As variáveis estão em uppercase como o PIPE_ID

Criar um item com valores obrigatórios

curl --request POST \
  --url https://api.sacflow.io/api/pipes/PIPE_ID/pipe-items \
  --header 'Authorization: Bearer API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": ACCOUNT_ID,
    "pipeId": PIPE_ID,
    "createdByUserId": CREATED_BY_USER_ID,
    "pipeStepId": PIPE_STEP_ID,
    "userId": USER_ID,
    "contactId": CONTACT_ID,
    "title": "TITLE",
    "priority": PRIORITY
}'

Criar um item com todos os valores

curl --request POST \
  --url https://api.sacflow.io/api/pipes/PIPE_ID/pipe-items \
  --header 'Authorization: Bearer API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": ACCOUNT_ID,
    "pipeId": PIPE_ID,
    "createdByUserId": CREATED_BY_USER_ID,
    "organizationId": ORGANIZATION_ID,
    "pipeStepId": PIPE_STEP_ID,
    "userId": USER_ID,
    "contactId": CONTACT_ID,
    "title": "TITLE",
    "description": "DESCRIPTION",
    "closingForecastDate": "CLOSING_FORECAST_DATE",
    "value": VALUE,
    "recurringValue": RECURRING_VALUE,
    "pipeOriginId": PIPE_ORIGIN_ID,
    "status": "STATUS",
    "priority": PRIORITY
}'

Detalhes adicionais

  • Certifique-se de utilizar valores válidos para os campos obrigatórios 

Para mais informações, entre em contato com o suporte técnico da Hyerdev através do WhatsApp 62 3932-3632.