Essa API permite integrar o seu formulário do site ou Meta Ads com o CRM do Sacflow para criar um novo card no funil.

Campos

Headers:

Params:

Body:

Como pegar os IDs para criar um novo item no funil

accountId: Identificador da conta associada.
token: para autenticação na API

pipeId (params): Identificador do funil onde o item será criado.
pipeStepId: Identificador do estágio no funil.

pipeOriginId: Identificador da origem.

userId: Identificador do usuário relacionado ao item

customFieldValues -> fiedld; só é possível preencher os campos personalizados do Formulário inicial.

Explicação dos campos opcionais:

organizationName: Alternativa para relacionar uma empresa ao card. Caso a empresa não exista ela será criada.
organizationDocument: Outra alternativa para adicionar uma empresa. O documento precisa ser válido.
contactNumber: Alternativa para relacionar um contato ao card. 
contactEmail: Outra alternativa para adicionar um contato ao card.
description: Descrição adicional do card.
closingForecastDate: Data estimada de fechamento do item (ISO 8601) no formato AAAA/MM/DD.
value: Valor financeiro associado ao item.
recurringValue: Valor recorrente associado ao item.
pipeOriginId: Identificador da origem do card. Pode ser encontrado nas configurações do funil.
priority: Prioridade do card. Sem prioridade(0), baixa(4), média(3), alta(2), urgente(1).
tags: Etiquetas para relacionar ao card. Podem ser encontradas na página de etiquetas na tab CRM.
customFieldValues: Campos personalizados do card. Podem ser encontrados nas configurações do funil, na tab "Campos". A explicação do uso na API está descrita acima na sessão "Como preencher um campo personalizado"

Como preencher um campo personalizado 

Para preencher um campo personalizado do formulário inicial via API é necessário fornecer os seguintes dados:

fieldId: Identificador do campo personalizado. Pode ser encontrado nas configurações do pipe.
value: O valor do campo. Este valor deve ser condizente com o tipo do campo personalizado. Exemplo: Um campo numérico aceita valores de tipo "number". 

Exemplo de como enviar no payload:

"customFieldValues": [
{
     "fieldId": 6,
     "value": 100
 },
{
     "fieldId": 12,
     "value": "Sacflow"
 }
]

É possível passar mais de um campo personalizado no payload.

ATENÇÃ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. O token pode ser encontrado na página de informações da conta.

Exemplo de requisição

As variáveis estão em maiúsculo, como o PIPE_ID e API_TOKEN.

Criar um item apenas com campos 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,
    "createdByUserId": CREATED_BY_USER_ID,
    "pipeStepId": PIPE_STEP_ID,
    "userId": USER_ID,
    "title": "TITLE",
}'

Criar um item com todos os campos:

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,
    "pipeStepId": PIPE_STEP_ID,
    "createdByUserId": CREATED_BY_USER_ID,
    "userId": USER_ID,
    "contactEmail": CONTACT_EMAIL,
    "contactNumber": CONTACT_NUMBER,
    "title": "TITLE",
    "description": "DESCRIPTION",
    "organizationName": ORGANIZATION_NAM,
    "organizationDocument": ORGANIZATION_DOCUMENT,
    "closingForecastDate": "CLOSING_FORECAST_DATE",
    "value": VALUE,
    "recurringValue": RECURRING_VALUE,
    "pipeOriginId": PIPE_ORIGIN_ID,
    "priority": PRIORITY,
    "tags": TAGS,
    "customFieldValues": CUSTOM_FIELD_VALUES
}'

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